Compare commits
32
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d6bb3c2ac7
|
||
|
|
5515c0e951
|
||
|
|
daf8ec27ab | ||
|
|
ec5e65ac82
|
||
|
|
d7e618e04c | ||
|
|
fc7a4560f0
|
||
|
|
52665cdee5
|
||
|
|
5300e684de | ||
|
|
607b986848
|
||
|
|
61c6e637ec | ||
|
|
efda077f4b | ||
|
|
e00f4f55b7 | ||
|
|
58fec4bf48
|
||
|
|
dd380a71db
|
||
|
|
0d130ce84a
|
||
|
|
28d9aa69e7
|
||
|
|
45e737dde2
|
||
|
|
2d1826235f
|
||
|
|
f558685f11
|
||
|
|
b21aa04557
|
||
|
|
01df7a0dff
|
||
|
|
8909274543
|
||
|
|
89f94cf1ff | ||
|
|
65774010aa | ||
|
|
42810c4fb3 | ||
|
|
39d19b4c7b | ||
|
|
8a0af954bf
|
||
|
|
94b0ff01ad
|
||
|
|
741f05e1be
|
||
|
|
d0f1d07363
|
||
|
|
08ac6d8fda
|
||
|
|
83b75ee0e5 |
@@ -196,3 +196,4 @@ $RECYCLE.BIN/
|
||||
|
||||
.idea/
|
||||
*.iml
|
||||
google-services.json
|
||||
+132
@@ -3,6 +3,138 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## 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
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_analysis` - `v2.2.1`](#wyatt_analysis---v221)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_analysis` - `v2.2.1`
|
||||
|
||||
- **FIX**: import right version.
|
||||
|
||||
|
||||
## 2022-07-11
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_analysis` - `v2.2.0`](#wyatt_analysis---v220)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_analysis` - `v2.2.0`
|
||||
|
||||
- **FIX**: rename to follow melos versioning and remove redundant rule.
|
||||
- **FEAT**: promote experimental, update analyzer rules and add some linter rules.
|
||||
|
||||
|
||||
## 2022-07-10
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`form_bloc_example` - `v1.1.0`](#form_bloc_example---v110)
|
||||
- [`wyatt_form_bloc` - `v0.0.3`](#wyatt_form_bloc---v003)
|
||||
- [`authentication_bloc_example` - `v1.0.1`](#authentication_bloc_example---v101)
|
||||
- [`wyatt_authentication_bloc` - `v0.2.1+1`](#wyatt_authentication_bloc---v0211)
|
||||
|
||||
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.
|
||||
|
||||
- `authentication_bloc_example` - `v1.0.1`
|
||||
- `wyatt_authentication_bloc` - `v0.2.1+1`
|
||||
|
||||
---
|
||||
|
||||
#### `form_bloc_example` - `v1.1.0`
|
||||
|
||||
- **FEAT**: add list option validator.
|
||||
- **DOCS**: add example app.
|
||||
|
||||
#### `wyatt_form_bloc` - `v0.0.3`
|
||||
|
||||
- **FEAT**: add helpers.
|
||||
- **FEAT**: add metadata on inputs.
|
||||
- **FEAT**: update to latest dart version.
|
||||
|
||||
|
||||
## 2022-06-24
|
||||
|
||||
### Changes
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
## 2.2.1
|
||||
|
||||
- **FIX**: import right version.
|
||||
|
||||
## 2.2.0
|
||||
|
||||
- **FIX**: rename to follow melos versioning and remove redundant rule.
|
||||
- **FEAT**: promote experimental, update analyzer rules and add some linter rules.
|
||||
|
||||
## 2.1.0
|
||||
|
||||
- **FEAT**: add experimental rules in appropriate file.
|
||||
|
||||
@@ -0,0 +1,206 @@
|
||||
# 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/>.
|
||||
|
||||
analyzer:
|
||||
language:
|
||||
strict-casts: true
|
||||
strict-inference: true
|
||||
strict-raw-types: true
|
||||
|
||||
errors:
|
||||
todo: ignore
|
||||
close_sinks: ignore
|
||||
missing_required_param: error
|
||||
missing_return: error
|
||||
|
||||
exclude:
|
||||
- example/**
|
||||
- lib/l10n/**
|
||||
- lib/generated/**
|
||||
- lib/generated_plugin_registrant.dart
|
||||
- test/.test_coverage.dart
|
||||
|
||||
linter:
|
||||
rules:
|
||||
- always_declare_return_types
|
||||
- always_require_non_null_named_parameters
|
||||
- always_put_control_body_on_new_line
|
||||
- always_put_required_named_parameters_first
|
||||
- always_use_package_imports
|
||||
- annotate_overrides
|
||||
- avoid_bool_literals_in_conditional_expressions
|
||||
- avoid_catching_errors
|
||||
- avoid_double_and_int_checks
|
||||
- avoid_dynamic_calls
|
||||
- avoid_empty_else
|
||||
- avoid_equals_and_hash_code_on_mutable_classes
|
||||
- avoid_escaping_inner_quotes
|
||||
- avoid_field_initializers_in_const_classes
|
||||
- avoid_function_literals_in_foreach_calls
|
||||
- avoid_init_to_null
|
||||
- avoid_js_rounded_ints
|
||||
- avoid_null_checks_in_equality_operators
|
||||
- avoid_positional_boolean_parameters
|
||||
- avoid_private_typedef_functions
|
||||
- avoid_redundant_argument_values
|
||||
- avoid_relative_lib_imports
|
||||
- avoid_renaming_method_parameters
|
||||
- avoid_return_types_on_setters
|
||||
- avoid_returning_null
|
||||
- avoid_returning_null_for_future
|
||||
- avoid_returning_null_for_void
|
||||
- avoid_returning_this
|
||||
- avoid_setters_without_getters
|
||||
- avoid_shadowing_type_parameters
|
||||
- avoid_single_cascade_in_expression_statements
|
||||
- avoid_slow_async_io
|
||||
- avoid_type_to_string
|
||||
- avoid_types_as_parameter_names
|
||||
- avoid_types_on_closure_parameters
|
||||
- avoid_unused_constructor_parameters
|
||||
- avoid_void_async
|
||||
- await_only_futures
|
||||
- camel_case_extensions
|
||||
- camel_case_types
|
||||
- cancel_subscriptions
|
||||
- cascade_invocations
|
||||
- cast_nullable_to_non_nullable
|
||||
- comment_references
|
||||
- conditional_uri_does_not_exist
|
||||
- constant_identifier_names
|
||||
- control_flow_in_finally
|
||||
- curly_braces_in_flow_control_structures
|
||||
- depend_on_referenced_packages
|
||||
- deprecated_consistency
|
||||
- directives_ordering
|
||||
- empty_catches
|
||||
- empty_constructor_bodies
|
||||
- empty_statements
|
||||
- eol_at_end_of_file
|
||||
- exhaustive_cases
|
||||
- file_names
|
||||
- flutter_style_todos
|
||||
- hash_and_equals
|
||||
- implementation_imports
|
||||
- iterable_contains_unrelated_type
|
||||
- join_return_with_assignment
|
||||
- leading_newlines_in_multiline_strings
|
||||
- library_names
|
||||
- library_prefixes
|
||||
- library_private_types_in_public_api
|
||||
- lines_longer_than_80_chars
|
||||
- list_remove_unrelated_type
|
||||
- literal_only_boolean_expressions
|
||||
- missing_whitespace_between_adjacent_strings
|
||||
- no_adjacent_strings_in_list
|
||||
- no_default_cases
|
||||
- no_duplicate_case_values
|
||||
- no_leading_underscores_for_local_identifiers
|
||||
- no_runtimeType_toString
|
||||
- non_constant_identifier_names
|
||||
- noop_primitive_operations
|
||||
- null_check_on_nullable_type_parameter
|
||||
- null_closures
|
||||
- one_member_abstracts
|
||||
- only_throw_errors
|
||||
- overridden_fields
|
||||
- package_api_docs
|
||||
- package_names
|
||||
- package_prefixed_library_names
|
||||
- parameter_assignments
|
||||
- prefer_adjacent_string_concatenation
|
||||
- prefer_asserts_in_initializer_lists
|
||||
- prefer_asserts_with_message
|
||||
- prefer_collection_literals
|
||||
- prefer_conditional_assignment
|
||||
- prefer_const_constructors
|
||||
- prefer_const_constructors_in_immutables
|
||||
- prefer_const_declarations
|
||||
- prefer_const_literals_to_create_immutables
|
||||
- prefer_constructors_over_static_methods
|
||||
- prefer_contains
|
||||
- prefer_equal_for_default_values
|
||||
- prefer_expression_function_bodies
|
||||
- prefer_final_fields
|
||||
- prefer_final_in_for_each
|
||||
- prefer_final_locals
|
||||
- prefer_for_elements_to_map_fromIterable
|
||||
- prefer_function_declarations_over_variables
|
||||
- prefer_generic_function_type_aliases
|
||||
- prefer_if_elements_to_conditional_expressions
|
||||
- prefer_if_null_operators
|
||||
- prefer_initializing_formals
|
||||
- prefer_inlined_adds
|
||||
- prefer_int_literals
|
||||
- prefer_interpolation_to_compose_strings
|
||||
- prefer_is_empty
|
||||
- prefer_is_not_empty
|
||||
- prefer_is_not_operator
|
||||
- prefer_iterable_whereType
|
||||
- prefer_mixin
|
||||
- prefer_null_aware_operators
|
||||
- prefer_null_aware_method_calls
|
||||
- prefer_single_quotes
|
||||
- prefer_spread_collections
|
||||
- prefer_typing_uninitialized_variables
|
||||
- prefer_void_to_null
|
||||
- provide_deprecation_message
|
||||
- recursive_getters
|
||||
- require_trailing_commas
|
||||
- slash_for_doc_comments
|
||||
- sort_unnamed_constructors_first
|
||||
- test_types_in_equals
|
||||
- throw_in_finally
|
||||
- tighten_type_of_initializing_formals
|
||||
- type_annotate_public_apis
|
||||
- type_init_formals
|
||||
- unawaited_futures
|
||||
- unnecessary_await_in_return
|
||||
- unnecessary_brace_in_string_interps
|
||||
- unnecessary_const
|
||||
- unnecessary_constructor_name
|
||||
- unnecessary_getters_setters
|
||||
- unnecessary_lambdas
|
||||
- unnecessary_late
|
||||
- unnecessary_new
|
||||
- unnecessary_null_aware_assignments
|
||||
- unnecessary_null_checks
|
||||
- unnecessary_null_in_if_null_operators
|
||||
- unnecessary_nullable_for_final_variable_declarations
|
||||
- unnecessary_overrides
|
||||
- unnecessary_parenthesis
|
||||
- unnecessary_raw_strings
|
||||
- unnecessary_statements
|
||||
- unnecessary_string_escapes
|
||||
- unnecessary_string_interpolations
|
||||
- unnecessary_this
|
||||
- unrelated_type_equality_checks
|
||||
- unsafe_html
|
||||
- use_enums
|
||||
- use_function_type_syntax_for_parameters
|
||||
- use_if_null_to_convert_nulls_to_bools
|
||||
- use_is_even_rather_than_modulo
|
||||
- use_late_for_private_fields_and_variables
|
||||
- use_named_constants
|
||||
- use_raw_strings
|
||||
- use_rethrow_when_possible
|
||||
- use_setters_to_change_properties
|
||||
- use_string_buffers
|
||||
- use_super_parameters
|
||||
- use_test_throws_matchers
|
||||
- use_to_and_as_if_applicable
|
||||
- valid_regexps
|
||||
- void_checks
|
||||
@@ -0,0 +1,206 @@
|
||||
# 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/>.
|
||||
|
||||
analyzer:
|
||||
language:
|
||||
strict-casts: true
|
||||
strict-inference: true
|
||||
strict-raw-types: true
|
||||
|
||||
errors:
|
||||
todo: ignore
|
||||
close_sinks: ignore
|
||||
missing_required_param: error
|
||||
missing_return: error
|
||||
|
||||
exclude:
|
||||
- example/**
|
||||
- lib/l10n/**
|
||||
- lib/generated/**
|
||||
- lib/generated_plugin_registrant.dart
|
||||
- test/.test_coverage.dart
|
||||
|
||||
linter:
|
||||
rules:
|
||||
- always_declare_return_types
|
||||
- always_require_non_null_named_parameters
|
||||
- always_put_control_body_on_new_line
|
||||
- always_put_required_named_parameters_first
|
||||
- always_use_package_imports
|
||||
- annotate_overrides
|
||||
- avoid_bool_literals_in_conditional_expressions
|
||||
- avoid_catching_errors
|
||||
- avoid_double_and_int_checks
|
||||
- avoid_dynamic_calls
|
||||
- avoid_empty_else
|
||||
- avoid_equals_and_hash_code_on_mutable_classes
|
||||
- avoid_escaping_inner_quotes
|
||||
- avoid_field_initializers_in_const_classes
|
||||
- avoid_function_literals_in_foreach_calls
|
||||
- avoid_init_to_null
|
||||
- avoid_js_rounded_ints
|
||||
- avoid_null_checks_in_equality_operators
|
||||
- avoid_positional_boolean_parameters
|
||||
- avoid_private_typedef_functions
|
||||
- avoid_redundant_argument_values
|
||||
- avoid_relative_lib_imports
|
||||
- avoid_renaming_method_parameters
|
||||
- avoid_return_types_on_setters
|
||||
- avoid_returning_null
|
||||
- avoid_returning_null_for_future
|
||||
- avoid_returning_null_for_void
|
||||
- avoid_returning_this
|
||||
- avoid_setters_without_getters
|
||||
- avoid_shadowing_type_parameters
|
||||
- avoid_single_cascade_in_expression_statements
|
||||
- avoid_slow_async_io
|
||||
- avoid_type_to_string
|
||||
- avoid_types_as_parameter_names
|
||||
- avoid_types_on_closure_parameters
|
||||
- avoid_unused_constructor_parameters
|
||||
- avoid_void_async
|
||||
- await_only_futures
|
||||
- camel_case_extensions
|
||||
- camel_case_types
|
||||
- cancel_subscriptions
|
||||
- cascade_invocations
|
||||
- cast_nullable_to_non_nullable
|
||||
- comment_references
|
||||
- conditional_uri_does_not_exist
|
||||
- constant_identifier_names
|
||||
- control_flow_in_finally
|
||||
- curly_braces_in_flow_control_structures
|
||||
- depend_on_referenced_packages
|
||||
- deprecated_consistency
|
||||
- directives_ordering
|
||||
- empty_catches
|
||||
- empty_constructor_bodies
|
||||
- empty_statements
|
||||
- eol_at_end_of_file
|
||||
- exhaustive_cases
|
||||
- file_names
|
||||
- flutter_style_todos
|
||||
- hash_and_equals
|
||||
- implementation_imports
|
||||
- iterable_contains_unrelated_type
|
||||
- join_return_with_assignment
|
||||
- leading_newlines_in_multiline_strings
|
||||
- library_names
|
||||
- library_prefixes
|
||||
- library_private_types_in_public_api
|
||||
- lines_longer_than_80_chars
|
||||
- list_remove_unrelated_type
|
||||
- literal_only_boolean_expressions
|
||||
- missing_whitespace_between_adjacent_strings
|
||||
- no_adjacent_strings_in_list
|
||||
- no_default_cases
|
||||
- no_duplicate_case_values
|
||||
- no_leading_underscores_for_local_identifiers
|
||||
- no_runtimeType_toString
|
||||
- non_constant_identifier_names
|
||||
- noop_primitive_operations
|
||||
- null_check_on_nullable_type_parameter
|
||||
- null_closures
|
||||
- one_member_abstracts
|
||||
- only_throw_errors
|
||||
- overridden_fields
|
||||
- package_api_docs
|
||||
- package_names
|
||||
- package_prefixed_library_names
|
||||
- parameter_assignments
|
||||
- prefer_adjacent_string_concatenation
|
||||
- prefer_asserts_in_initializer_lists
|
||||
- prefer_asserts_with_message
|
||||
- prefer_collection_literals
|
||||
- prefer_conditional_assignment
|
||||
- prefer_const_constructors
|
||||
- prefer_const_constructors_in_immutables
|
||||
- prefer_const_declarations
|
||||
- prefer_const_literals_to_create_immutables
|
||||
- prefer_constructors_over_static_methods
|
||||
- prefer_contains
|
||||
- prefer_equal_for_default_values
|
||||
- prefer_expression_function_bodies
|
||||
- prefer_final_fields
|
||||
- prefer_final_in_for_each
|
||||
- prefer_final_locals
|
||||
- prefer_for_elements_to_map_fromIterable
|
||||
- prefer_function_declarations_over_variables
|
||||
- prefer_generic_function_type_aliases
|
||||
- prefer_if_elements_to_conditional_expressions
|
||||
- prefer_if_null_operators
|
||||
- prefer_initializing_formals
|
||||
- prefer_inlined_adds
|
||||
- prefer_int_literals
|
||||
- prefer_interpolation_to_compose_strings
|
||||
- prefer_is_empty
|
||||
- prefer_is_not_empty
|
||||
- prefer_is_not_operator
|
||||
- prefer_iterable_whereType
|
||||
- prefer_mixin
|
||||
- prefer_null_aware_operators
|
||||
- prefer_null_aware_method_calls
|
||||
- prefer_single_quotes
|
||||
- prefer_spread_collections
|
||||
- prefer_typing_uninitialized_variables
|
||||
- prefer_void_to_null
|
||||
- provide_deprecation_message
|
||||
- recursive_getters
|
||||
- require_trailing_commas
|
||||
- slash_for_doc_comments
|
||||
- sort_unnamed_constructors_first
|
||||
- test_types_in_equals
|
||||
- throw_in_finally
|
||||
- tighten_type_of_initializing_formals
|
||||
- type_annotate_public_apis
|
||||
- type_init_formals
|
||||
- unawaited_futures
|
||||
- unnecessary_await_in_return
|
||||
- unnecessary_brace_in_string_interps
|
||||
- unnecessary_const
|
||||
- unnecessary_constructor_name
|
||||
- unnecessary_getters_setters
|
||||
- unnecessary_lambdas
|
||||
- unnecessary_late
|
||||
- unnecessary_new
|
||||
- unnecessary_null_aware_assignments
|
||||
- unnecessary_null_checks
|
||||
- unnecessary_null_in_if_null_operators
|
||||
- unnecessary_nullable_for_final_variable_declarations
|
||||
- unnecessary_overrides
|
||||
- unnecessary_parenthesis
|
||||
- unnecessary_raw_strings
|
||||
- unnecessary_statements
|
||||
- unnecessary_string_escapes
|
||||
- unnecessary_string_interpolations
|
||||
- unnecessary_this
|
||||
- unrelated_type_equality_checks
|
||||
- unsafe_html
|
||||
- use_enums
|
||||
- use_function_type_syntax_for_parameters
|
||||
- use_if_null_to_convert_nulls_to_bools
|
||||
- use_is_even_rather_than_modulo
|
||||
- use_late_for_private_fields_and_variables
|
||||
- use_named_constants
|
||||
- use_raw_strings
|
||||
- use_rethrow_when_possible
|
||||
- use_setters_to_change_properties
|
||||
- use_string_buffers
|
||||
- use_super_parameters
|
||||
- use_test_throws_matchers
|
||||
- use_to_and_as_if_applicable
|
||||
- valid_regexps
|
||||
- void_checks
|
||||
@@ -0,0 +1,32 @@
|
||||
# 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.2.1.1.yaml
|
||||
|
||||
linter:
|
||||
rules:
|
||||
- avoid_print
|
||||
- avoid_unnecessary_containers
|
||||
- avoid_web_libraries_in_flutter
|
||||
- no_logic_in_create_state
|
||||
- sized_box_for_whitespace
|
||||
- sized_box_shrink_expand
|
||||
- sort_child_properties_last
|
||||
- use_build_context_synchronously
|
||||
- use_colored_box
|
||||
- use_decorated_box
|
||||
- use_full_hex_values_for_flutter_colors
|
||||
- use_key_in_widget_constructors
|
||||
@@ -0,0 +1,32 @@
|
||||
# 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.2.2.1.yaml
|
||||
|
||||
linter:
|
||||
rules:
|
||||
- avoid_print
|
||||
- avoid_unnecessary_containers
|
||||
- avoid_web_libraries_in_flutter
|
||||
- no_logic_in_create_state
|
||||
- sized_box_for_whitespace
|
||||
- sized_box_shrink_expand
|
||||
- sort_child_properties_last
|
||||
- use_build_context_synchronously
|
||||
- use_colored_box
|
||||
- use_decorated_box
|
||||
- use_full_hex_values_for_flutter_colors
|
||||
- use_key_in_widget_constructors
|
||||
@@ -14,4 +14,4 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.flutter.2.0.0.yaml
|
||||
include: package:wyatt_analysis/analysis_options.flutter.2.2.1.yaml
|
||||
|
||||
@@ -14,4 +14,4 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.2.0.0.yaml
|
||||
include: package:wyatt_analysis/analysis_options.2.2.1.yaml
|
||||
|
||||
@@ -19,4 +19,4 @@
|
||||
/// and [Wyatt Studio](https://wyatt-studio.fr).
|
||||
library wyatt_analysis;
|
||||
|
||||
const String wyattAnalysisVersion = '2.0.0';
|
||||
const String wyattAnalysisVersion = '2.2.1';
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
name: wyatt_analysis
|
||||
description: Lint rules for Dart and Flutter used internally at Wyatt and Wyatt Studio.
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis
|
||||
version: 2.1.0
|
||||
version: 2.2.1
|
||||
|
||||
environment:
|
||||
sdk: '>=2.12.0 <3.0.0'
|
||||
@@ -1,3 +1,11 @@
|
||||
## 0.2.1+2
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
## 0.2.1+1
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
## 0.2.1
|
||||
|
||||
- **FEAT**: add google, facebook, apple, twitter login.
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
## 1.0.1
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
@@ -14,6 +14,14 @@
|
||||
}
|
||||
},
|
||||
"oauth_client": [
|
||||
{
|
||||
"client_id": "136771801992-nps7ic22shstvgdv0c2ojvbkj3dkntum.apps.googleusercontent.com",
|
||||
"client_type": 1,
|
||||
"android_info": {
|
||||
"package_name": "com.example.authentication_bloc_example",
|
||||
"certificate_hash": "5d8790309e13b68c35e5d4d8437c35c6d15e6131"
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-ncuib3rbu7p4ro4eo5su4vaudn2u4qrv.apps.googleusercontent.com",
|
||||
"client_type": 3
|
||||
@@ -77,58 +85,6 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_info": {
|
||||
"mobilesdk_app_id": "1:136771801992:android:d20e0361057e815197203d",
|
||||
"android_client_info": {
|
||||
"package_name": "com.example.example"
|
||||
}
|
||||
},
|
||||
"oauth_client": [
|
||||
{
|
||||
"client_id": "136771801992-n2pq8oqutvrqj58e05hbavvc7n1jdfjb.apps.googleusercontent.com",
|
||||
"client_type": 1,
|
||||
"android_info": {
|
||||
"package_name": "com.example.example",
|
||||
"certificate_hash": "5d8790309e13b68c35e5d4d8437c35c6d15e6131"
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-pj9s88ao7d99pnp4ace75nj1abtmoq7e.apps.googleusercontent.com",
|
||||
"client_type": 1,
|
||||
"android_info": {
|
||||
"package_name": "com.example.example",
|
||||
"certificate_hash": "bc8faf31c0b0085dc358b2319684e10c93f42719"
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-ncuib3rbu7p4ro4eo5su4vaudn2u4qrv.apps.googleusercontent.com",
|
||||
"client_type": 3
|
||||
}
|
||||
],
|
||||
"api_key": [
|
||||
{
|
||||
"current_key": "AIzaSyAYS14uXupkS158Q5QAFP1864UrUN_yDSk"
|
||||
}
|
||||
],
|
||||
"services": {
|
||||
"appinvite_service": {
|
||||
"other_platform_oauth_client": [
|
||||
{
|
||||
"client_id": "136771801992-ncuib3rbu7p4ro4eo5su4vaudn2u4qrv.apps.googleusercontent.com",
|
||||
"client_type": 3
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-e585bm1n9b3lv89t4phrl9u0glsg52ua.apps.googleusercontent.com",
|
||||
"client_type": 2,
|
||||
"ios_info": {
|
||||
"bundle_id": "com.example.example"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"configuration_version": "1"
|
||||
|
||||
@@ -31,23 +31,29 @@ class App extends StatelessWidget {
|
||||
|
||||
static FormData getNormalFormData() {
|
||||
return const FormData([
|
||||
FormEntry(formFieldName, Name.pure()),
|
||||
FormEntry(formFieldPhone, Phone.pure()),
|
||||
FormEntry(formFieldPro, Boolean.pure()),
|
||||
FormEntry(formFieldConfirmedPassword, ConfirmedPassword.pure(),
|
||||
export: false),
|
||||
FormInput(formFieldName, Name.pure()),
|
||||
FormInput(formFieldPhone, Phone.pure()),
|
||||
FormInput(formFieldPro, Boolean.pure()),
|
||||
FormInput(
|
||||
formFieldConfirmedPassword,
|
||||
ConfirmedPassword.pure(),
|
||||
metadata: FormInputMetadata(export: false),
|
||||
),
|
||||
]);
|
||||
}
|
||||
|
||||
static FormData getProFormData() {
|
||||
return const FormData([
|
||||
FormEntry(formFieldName, Name.pure()),
|
||||
FormEntry(formFieldPhone, Phone.pure()),
|
||||
FormEntry(formFieldPro, Boolean.pure()),
|
||||
FormEntry(formFieldSiren, Siren.pure()),
|
||||
FormEntry(formFieldIban, Iban.pure()),
|
||||
FormEntry(formFieldConfirmedPassword, ConfirmedPassword.pure(),
|
||||
export: false),
|
||||
FormInput(formFieldName, Name.pure()),
|
||||
FormInput(formFieldPhone, Phone.pure()),
|
||||
FormInput(formFieldPro, Boolean.pure()),
|
||||
FormInput(formFieldSiren, Siren.pure()),
|
||||
FormInput(formFieldIban, Iban.pure()),
|
||||
FormInput(
|
||||
formFieldConfirmedPassword,
|
||||
ConfirmedPassword.pure(),
|
||||
metadata: FormInputMetadata(export: false),
|
||||
),
|
||||
]);
|
||||
}
|
||||
|
||||
@@ -103,42 +109,42 @@ class App extends StatelessWidget {
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
AuthenticationRepositoryInterface _authenticationRepository =
|
||||
AuthenticationRepositoryInterface authenticationRepository =
|
||||
AuthenticationRepositoryFirebase();
|
||||
|
||||
AuthenticationCubit _authenticationCubit = AuthenticationCubit(
|
||||
authenticationRepository: _authenticationRepository,
|
||||
AuthenticationCubit authenticationCubit = AuthenticationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
onAuthSuccess: onAuthSuccess,
|
||||
);
|
||||
|
||||
SignUpCubit _signUpCubit = SignUpCubit(
|
||||
authenticationRepository: _authenticationRepository,
|
||||
authenticationCubit: _authenticationCubit,
|
||||
SignUpCubit signUpCubit = SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: getNormalFormData(),
|
||||
onSignUpSuccess: onSignUpSuccess,
|
||||
);
|
||||
|
||||
SignInCubit _signInCubit = SignInCubit(
|
||||
authenticationRepository: _authenticationRepository,
|
||||
authenticationCubit: _authenticationCubit,
|
||||
SignInCubit signInCubit = SignInCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
);
|
||||
|
||||
return MultiRepositoryProvider(
|
||||
providers: [
|
||||
RepositoryProvider<AuthenticationRepositoryInterface>(
|
||||
create: (context) => _authenticationRepository,
|
||||
create: (context) => authenticationRepository,
|
||||
),
|
||||
],
|
||||
child: MultiBlocProvider(
|
||||
providers: [
|
||||
BlocProvider<AuthenticationCubit>(
|
||||
create: (context) => _authenticationCubit..init(),
|
||||
create: (context) => authenticationCubit..init(),
|
||||
),
|
||||
BlocProvider<SignUpCubit>(
|
||||
create: (context) => _signUpCubit,
|
||||
create: (context) => signUpCubit,
|
||||
),
|
||||
BlocProvider<SignInCubit>(
|
||||
create: (context) => _signInCubit,
|
||||
create: (context) => signInCubit,
|
||||
),
|
||||
],
|
||||
child: const AppView(),
|
||||
|
||||
@@ -37,7 +37,7 @@ class _NameInput extends StatelessWidget {
|
||||
labelText: 'name',
|
||||
helperText: '',
|
||||
errorText:
|
||||
state.data.input(formFieldName).invalid ? 'invalid name' : null,
|
||||
state.data.isNotValid(formFieldName) ? 'invalid name' : null,
|
||||
),
|
||||
);
|
||||
},
|
||||
@@ -58,7 +58,7 @@ class _PhoneInput extends StatelessWidget {
|
||||
decoration: InputDecoration(
|
||||
labelText: 'phone',
|
||||
helperText: '',
|
||||
errorText: state.data.input(formFieldPhone).invalid
|
||||
errorText: state.data.isNotValid(formFieldPhone)
|
||||
? 'invalid phone'
|
||||
: null,
|
||||
),
|
||||
@@ -81,7 +81,7 @@ class _SirenInput extends StatelessWidget {
|
||||
decoration: InputDecoration(
|
||||
labelText: 'siren',
|
||||
helperText: '',
|
||||
errorText: state.data.input(formFieldSiren).invalid
|
||||
errorText: state.data.isNotValid(formFieldSiren)
|
||||
? 'invalid SIREN'
|
||||
: null,
|
||||
),
|
||||
@@ -105,7 +105,7 @@ class _IbanInput extends StatelessWidget {
|
||||
labelText: 'iban',
|
||||
helperText: '',
|
||||
errorText:
|
||||
state.data.input(formFieldIban).invalid ? 'invalid IBAN' : null,
|
||||
state.data.isNotValid(formFieldIban) ? 'invalid IBAN' : null,
|
||||
),
|
||||
);
|
||||
},
|
||||
@@ -149,8 +149,7 @@ class _PasswordInput extends StatelessWidget {
|
||||
.read<SignUpCubit>()
|
||||
.state
|
||||
.data
|
||||
.input(formFieldConfirmedPassword)
|
||||
.value,
|
||||
.valueOf<String, ValidationError>(formFieldConfirmedPassword),
|
||||
),
|
||||
);
|
||||
},
|
||||
@@ -185,7 +184,7 @@ class _ConfirmPasswordInput extends StatelessWidget {
|
||||
decoration: InputDecoration(
|
||||
labelText: 'confirm password',
|
||||
helperText: '',
|
||||
errorText: state.data.input(formFieldConfirmedPassword).invalid
|
||||
errorText: state.data.isNotValid(formFieldConfirmedPassword)
|
||||
? 'passwords do not match'
|
||||
: null,
|
||||
),
|
||||
@@ -203,7 +202,7 @@ class _CheckIsProInput extends StatelessWidget {
|
||||
trailing: BlocBuilder<SignUpCubit, SignUpState>(
|
||||
builder: (context, state) {
|
||||
return Checkbox(
|
||||
value: state.data.input<bool>(formFieldPro).value,
|
||||
value: state.data.valueOf<bool, ValidationError>(formFieldPro),
|
||||
onChanged: (isPro) {
|
||||
final value =
|
||||
isPro!; // tristate is false, so value can't be null
|
||||
@@ -297,7 +296,7 @@ class SignUpForm extends StatelessWidget {
|
||||
const SizedBox(height: 8),
|
||||
BlocBuilder<SignUpCubit, SignUpState>(
|
||||
builder: (context, state) {
|
||||
if (state.data.input<bool>(formFieldPro).value) {
|
||||
if (state.data.valueOf<bool, ValidationError>(formFieldPro)) {
|
||||
return Column(children: [
|
||||
_SirenInput(),
|
||||
const SizedBox(height: 8),
|
||||
|
||||
@@ -15,7 +15,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev
|
||||
# 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
|
||||
version: 1.0.1
|
||||
|
||||
environment:
|
||||
sdk: ">=2.16.2 <3.0.0"
|
||||
@@ -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.2
|
||||
ref: wyatt_form_bloc-v0.0.4
|
||||
path: packages/wyatt_form_bloc
|
||||
|
||||
# The following adds the Cupertino Icons font to your application.
|
||||
@@ -55,7 +55,7 @@ dev_dependencies:
|
||||
# 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: ^1.0.0
|
||||
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
|
||||
|
||||
@@ -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.4
|
||||
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
|
||||
+1
-1
@@ -33,7 +33,7 @@ class PasswordResetCubit extends Cubit<PasswordResetState> {
|
||||
emit(
|
||||
state.copyWith(
|
||||
email: email,
|
||||
status: FormData.validate([email]),
|
||||
status: FormStatus.validate([email]),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -39,7 +39,7 @@ class SignInCubit extends Cubit<SignInState> {
|
||||
emit(
|
||||
state.copyWith(
|
||||
email: email,
|
||||
status: FormData.validate([email, state.password]),
|
||||
status: FormStatus.validate([email, state.password]),
|
||||
),
|
||||
);
|
||||
}
|
||||
@@ -49,7 +49,7 @@ class SignInCubit extends Cubit<SignInState> {
|
||||
emit(
|
||||
state.copyWith(
|
||||
password: password,
|
||||
status: FormData.validate([state.email, password]),
|
||||
status: FormStatus.validate([state.email, password]),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -44,16 +44,16 @@ class SignUpCubit extends Cubit<SignUpState> {
|
||||
void emailChanged(String value) {
|
||||
final Email email = Email.dirty(value);
|
||||
|
||||
final List<FormInput<dynamic, ValidationError>> inputsToValidate = [
|
||||
final List<FormInputValidator<dynamic, ValidationError>> toValidate = [
|
||||
email,
|
||||
state.password,
|
||||
...state.data.inputs<dynamic>(),
|
||||
...state.data.validators<dynamic, ValidationError>(),
|
||||
];
|
||||
|
||||
emit(
|
||||
state.copyWith(
|
||||
email: email,
|
||||
status: FormData.validate(inputsToValidate),
|
||||
status: FormStatus.validate(toValidate),
|
||||
),
|
||||
);
|
||||
}
|
||||
@@ -61,26 +61,26 @@ class SignUpCubit extends Cubit<SignUpState> {
|
||||
void passwordChanged(String value) {
|
||||
final Password password = Password.dirty(value);
|
||||
|
||||
final List<FormInput<dynamic, ValidationError>> inputsToValidate = [
|
||||
final List<FormInputValidator<dynamic, ValidationError>> toValidate = [
|
||||
state.email,
|
||||
password,
|
||||
...state.data.inputs<dynamic>(),
|
||||
...state.data.validators<dynamic, ValidationError>(),
|
||||
];
|
||||
|
||||
emit(
|
||||
state.copyWith(
|
||||
password: password,
|
||||
status: FormData.validate(inputsToValidate),
|
||||
status: FormStatus.validate(toValidate),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
// Take from wyatt_form_bloc/wyatt_form_bloc.dart
|
||||
void dataChanged<T>(String field, FormInput dirtyValue) {
|
||||
void dataChanged<T>(String field, FormInputValidator dirtyValue) {
|
||||
final _form = state.data.clone();
|
||||
|
||||
if (_form.contains(field)) {
|
||||
_form.update(field, dirtyValue);
|
||||
_form.updateValidator(field, dirtyValue);
|
||||
} else {
|
||||
throw Exception('Form field $field not found');
|
||||
}
|
||||
@@ -88,8 +88,12 @@ class SignUpCubit extends Cubit<SignUpState> {
|
||||
emit(
|
||||
state.copyWith(
|
||||
data: _form,
|
||||
status: FormData.validate(
|
||||
[state.email, state.password, ..._form.inputs<dynamic>()],
|
||||
status: FormStatus.validate(
|
||||
[
|
||||
state.email,
|
||||
state.password,
|
||||
...state.data.validators<dynamic, ValidationError>(),
|
||||
],
|
||||
),
|
||||
),
|
||||
);
|
||||
@@ -120,8 +124,12 @@ class SignUpCubit extends Cubit<SignUpState> {
|
||||
emit(
|
||||
state.copyWith(
|
||||
data: _form,
|
||||
status: FormData.validate(
|
||||
[state.email, state.password, ..._form.inputs<dynamic>()],
|
||||
status: FormStatus.validate(
|
||||
[
|
||||
state.email,
|
||||
state.password,
|
||||
...state.data.validators<dynamic, ValidationError>(),
|
||||
],
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
name: wyatt_authentication_bloc
|
||||
description: Authentication BLoC for Flutter
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_authentication_bloc
|
||||
version: 0.2.1
|
||||
version: 0.2.1+2
|
||||
|
||||
environment:
|
||||
sdk: ">=2.15.1 <3.0.0"
|
||||
@@ -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.2
|
||||
ref: wyatt_form_bloc-v0.0.4
|
||||
path: packages/wyatt_form_bloc
|
||||
|
||||
|
||||
@@ -35,5 +35,5 @@ dev_dependencies:
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.1.0
|
||||
ref: wyatt_analysis-v2.2.1
|
||||
path: packages/wyatt_analysis
|
||||
|
||||
@@ -68,9 +68,9 @@ void main() {
|
||||
SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
).state,
|
||||
SignUpState(data: FormData.empty()),
|
||||
const SignUpState(data: FormData.empty()),
|
||||
);
|
||||
});
|
||||
|
||||
@@ -80,11 +80,11 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
act: (SignUpCubit cubit) => cubit.emailChanged(invalidEmailString),
|
||||
expect: () => <SignUpState>[
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
email: invalidEmail,
|
||||
status: FormStatus.invalid,
|
||||
data: FormData.empty(),
|
||||
@@ -97,15 +97,15 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
seed: () => SignUpState(
|
||||
seed: () => const SignUpState(
|
||||
password: validPassword,
|
||||
data: FormData.empty(),
|
||||
),
|
||||
act: (SignUpCubit cubit) => cubit.emailChanged(validEmailString),
|
||||
expect: () => <SignUpState>[
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
status: FormStatus.valid,
|
||||
@@ -121,12 +121,12 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
act: (SignUpCubit cubit) =>
|
||||
cubit.passwordChanged(invalidPasswordString),
|
||||
expect: () => <SignUpState>[
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
password: invalidPassword,
|
||||
status: FormStatus.invalid,
|
||||
data: FormData.empty(),
|
||||
@@ -139,15 +139,15 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
seed: () => SignUpState(
|
||||
seed: () => const SignUpState(
|
||||
email: validEmail,
|
||||
data: FormData.empty(),
|
||||
),
|
||||
act: (SignUpCubit cubit) => cubit.passwordChanged(validPasswordString),
|
||||
expect: () => <SignUpState>[
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
status: FormStatus.valid,
|
||||
@@ -163,7 +163,7 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
act: (SignUpCubit cubit) => cubit.signUpFormSubmitted(),
|
||||
expect: () => const <SignUpState>[],
|
||||
@@ -174,9 +174,9 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
seed: () => SignUpState(
|
||||
seed: () => const SignUpState(
|
||||
status: FormStatus.valid,
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
@@ -199,9 +199,9 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
seed: () => SignUpState(
|
||||
seed: () => const SignUpState(
|
||||
status: FormStatus.valid,
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
@@ -209,13 +209,13 @@ void main() {
|
||||
),
|
||||
act: (SignUpCubit cubit) => cubit.signUpFormSubmitted(),
|
||||
expect: () => <SignUpState>[
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
status: FormStatus.submissionInProgress,
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
data: FormData.empty(),
|
||||
),
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
status: FormStatus.submissionSuccess,
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
@@ -238,9 +238,9 @@ void main() {
|
||||
build: () => SignUpCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
authenticationCubit: authenticationCubit,
|
||||
entries: FormData.empty(),
|
||||
entries: const FormData.empty(),
|
||||
),
|
||||
seed: () => SignUpState(
|
||||
seed: () => const SignUpState(
|
||||
status: FormStatus.valid,
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
@@ -248,13 +248,13 @@ void main() {
|
||||
),
|
||||
act: (SignUpCubit cubit) => cubit.signUpFormSubmitted(),
|
||||
expect: () => <SignUpState>[
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
status: FormStatus.submissionInProgress,
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
data: FormData.empty(),
|
||||
),
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
status: FormStatus.submissionFailure,
|
||||
email: validEmail,
|
||||
password: validPassword,
|
||||
|
||||
@@ -26,10 +26,10 @@ void main() {
|
||||
group('SignUpState', () {
|
||||
test('supports value comparisons', () {
|
||||
expect(
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
),
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
),
|
||||
);
|
||||
@@ -37,10 +37,10 @@ void main() {
|
||||
|
||||
test('returns same object when no properties are passed', () {
|
||||
expect(
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
).copyWith(),
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
),
|
||||
);
|
||||
@@ -48,10 +48,10 @@ void main() {
|
||||
|
||||
test('returns object with updated status when status is passed', () {
|
||||
expect(
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
).copyWith(status: FormStatus.pure),
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
),
|
||||
);
|
||||
@@ -59,10 +59,10 @@ void main() {
|
||||
|
||||
test('returns object with updated email when email is passed', () {
|
||||
expect(
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
).copyWith(email: email),
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
email: email,
|
||||
data: FormData.empty(),
|
||||
),
|
||||
@@ -71,10 +71,10 @@ void main() {
|
||||
|
||||
test('returns object with updated password when password is passed', () {
|
||||
expect(
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
).copyWith(password: password),
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
password: password,
|
||||
data: FormData.empty(),
|
||||
),
|
||||
@@ -85,12 +85,12 @@ void main() {
|
||||
'returns object with updated data'
|
||||
' when data is passed', () {
|
||||
expect(
|
||||
SignUpState(
|
||||
const SignUpState(
|
||||
data: FormData.empty(),
|
||||
).copyWith(
|
||||
data: const FormData(
|
||||
[
|
||||
FormEntry(
|
||||
FormInput(
|
||||
'field',
|
||||
Name.pure(),
|
||||
),
|
||||
@@ -100,7 +100,7 @@ void main() {
|
||||
const SignUpState(
|
||||
data: FormData(
|
||||
[
|
||||
FormEntry(
|
||||
FormInput(
|
||||
'field',
|
||||
Name.pure(),
|
||||
),
|
||||
|
||||
@@ -116,6 +116,19 @@ Widget onBuild(BuildContext context, CounterState state) {
|
||||
}
|
||||
```
|
||||
|
||||
If needed, you can wrap what depends on the state with the function `onWrap`.
|
||||
|
||||
```dart
|
||||
@override
|
||||
Widget onWrap(BuildContext context, Widget child) {
|
||||
return Scaffold(
|
||||
appBar: AppBar(
|
||||
title: const Text('Title'),
|
||||
),
|
||||
body: child,
|
||||
);
|
||||
```
|
||||
|
||||
> Note: you can override `onBuild`, but also `onListen`, `shouldBuildWhen` and `shouldListenWhen` methods.
|
||||
|
||||
### Both BlocProvider and BlocConsumer
|
||||
|
||||
@@ -36,17 +36,20 @@ abstract class BlocBaseConsumerScreen<B extends BlocBase<S>, S extends Object>
|
||||
/// must return a widget.
|
||||
Widget onBuild(BuildContext context, S state);
|
||||
|
||||
/// The [onWrap] function which will be invoked on each widget build.
|
||||
/// The [onWrap] takes the `BuildContext`
|
||||
/// Used to wrap which depends on the state.
|
||||
Widget onWrap(BuildContext context, Widget child) => child;
|
||||
|
||||
/// Takes the `BuildContext` along with the `state`
|
||||
/// and is responsible for executing in response to `state` changes.
|
||||
void onListen(BuildContext context, S state) {}
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocConsumer<B, S>(
|
||||
Widget build(BuildContext context) => BlocConsumer<B, S>(
|
||||
listenWhen: shouldListenWhen,
|
||||
listener: onListen,
|
||||
buildWhen: shouldBuildWhen,
|
||||
builder: onBuild,
|
||||
builder: (context, state) => onWrap(context, onBuild(context, state)),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -28,10 +28,8 @@ abstract class BlocBaseProviderScreen<B extends BlocBase<S>, S extends Object>
|
||||
Widget buildChild(BuildContext context);
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocProvider<B>(
|
||||
Widget build(BuildContext context) => BlocProvider<B>(
|
||||
create: (_) => create(context),
|
||||
child: Builder(builder: buildChild),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,10 +26,8 @@ abstract class BlocBaseScreen<B extends BlocBase<S>, S extends Object>
|
||||
B create(BuildContext context);
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocProvider<B>(
|
||||
Widget build(BuildContext context) => BlocProvider<B>(
|
||||
create: (_) => create(context),
|
||||
child: super.build(context),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -21,8 +21,8 @@ import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
/// [Bloc] and [Cubit] widgets.
|
||||
mixin BlocBaseProviderMixin<B extends BlocBase<Object>> {
|
||||
/// Returns the [BlocBase] used by this [BlocBaseProviderMixin].
|
||||
B bloc(BuildContext context) => BlocProvider.of<B>(context);
|
||||
B bloc(BuildContext context) => context.read<B>();
|
||||
|
||||
/// Returns the [BlocBase] used by this [BlocBaseProviderMixin].
|
||||
R repo<R>(BuildContext context) => RepositoryProvider.of<R>(context);
|
||||
R repo<R>(BuildContext context) => context.read<R>();
|
||||
}
|
||||
|
||||
@@ -20,7 +20,5 @@ import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
/// [Bloc] specific mixin that provides implementation
|
||||
/// of helper methods for events.
|
||||
mixin BlocProviderMixin<B extends Bloc<E, Object>, E> {
|
||||
void add(BuildContext context, E event) {
|
||||
BlocProvider.of<B>(context).add(event);
|
||||
}
|
||||
void add(BuildContext context, E event) => context.read<B>().add(event);
|
||||
}
|
||||
|
||||
@@ -21,5 +21,5 @@ dev_dependencies:
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.1.0
|
||||
ref: wyatt_analysis-v2.2.1
|
||||
path: packages/wyatt_analysis
|
||||
@@ -10,6 +10,6 @@ dev_dependencies:
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.1.0
|
||||
ref: wyatt_analysis-v2.2.1
|
||||
path: packages/wyatt_analysis
|
||||
dependencies: {meta: ^1.8.0}
|
||||
|
||||
@@ -14,6 +14,14 @@
|
||||
}
|
||||
},
|
||||
"oauth_client": [
|
||||
{
|
||||
"client_id": "136771801992-nps7ic22shstvgdv0c2ojvbkj3dkntum.apps.googleusercontent.com",
|
||||
"client_type": 1,
|
||||
"android_info": {
|
||||
"package_name": "com.example.authentication_bloc_example",
|
||||
"certificate_hash": "5d8790309e13b68c35e5d4d8437c35c6d15e6131"
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-ncuib3rbu7p4ro4eo5su4vaudn2u4qrv.apps.googleusercontent.com",
|
||||
"client_type": 3
|
||||
@@ -77,58 +85,6 @@
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_info": {
|
||||
"mobilesdk_app_id": "1:136771801992:android:d20e0361057e815197203d",
|
||||
"android_client_info": {
|
||||
"package_name": "com.example.example"
|
||||
}
|
||||
},
|
||||
"oauth_client": [
|
||||
{
|
||||
"client_id": "136771801992-n2pq8oqutvrqj58e05hbavvc7n1jdfjb.apps.googleusercontent.com",
|
||||
"client_type": 1,
|
||||
"android_info": {
|
||||
"package_name": "com.example.example",
|
||||
"certificate_hash": "5d8790309e13b68c35e5d4d8437c35c6d15e6131"
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-pj9s88ao7d99pnp4ace75nj1abtmoq7e.apps.googleusercontent.com",
|
||||
"client_type": 1,
|
||||
"android_info": {
|
||||
"package_name": "com.example.example",
|
||||
"certificate_hash": "bc8faf31c0b0085dc358b2319684e10c93f42719"
|
||||
}
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-ncuib3rbu7p4ro4eo5su4vaudn2u4qrv.apps.googleusercontent.com",
|
||||
"client_type": 3
|
||||
}
|
||||
],
|
||||
"api_key": [
|
||||
{
|
||||
"current_key": "AIzaSyAYS14uXupkS158Q5QAFP1864UrUN_yDSk"
|
||||
}
|
||||
],
|
||||
"services": {
|
||||
"appinvite_service": {
|
||||
"other_platform_oauth_client": [
|
||||
{
|
||||
"client_id": "136771801992-ncuib3rbu7p4ro4eo5su4vaudn2u4qrv.apps.googleusercontent.com",
|
||||
"client_type": 3
|
||||
},
|
||||
{
|
||||
"client_id": "136771801992-e585bm1n9b3lv89t4phrl9u0glsg52ua.apps.googleusercontent.com",
|
||||
"client_type": 2,
|
||||
"ios_info": {
|
||||
"bundle_id": "com.example.example"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"configuration_version": "1"
|
||||
|
||||
@@ -49,7 +49,7 @@ dev_dependencies:
|
||||
# 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: ^1.0.0
|
||||
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
|
||||
|
||||
@@ -23,5 +23,5 @@ dev_dependencies:
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.1.0
|
||||
ref: wyatt_analysis-v2.2.1
|
||||
path: packages/wyatt_analysis
|
||||
|
||||
@@ -1,3 +1,13 @@
|
||||
## 0.0.4
|
||||
|
||||
- **FEAT**: add form validator class with strategy design pattern.
|
||||
|
||||
## 0.0.3
|
||||
|
||||
- **FEAT**: add helpers.
|
||||
- **FEAT**: add metadata on inputs.
|
||||
- **FEAT**: update to latest dart version.
|
||||
|
||||
## 0.0.2
|
||||
|
||||
- **FEAT**: add list option validator.
|
||||
|
||||
@@ -30,21 +30,22 @@ Form Bloc for Dart & Flutter.
|
||||
## Features
|
||||
|
||||
- Form
|
||||
* FormInput: *atom of a form*
|
||||
* FormInputValidator:
|
||||
- Store data
|
||||
- Validate this data
|
||||
* FormEntry: *shell of this atom*
|
||||
- Associate a key to an input
|
||||
- Configure form attribute (exportation, name...)
|
||||
* FormData: *collection of entries*
|
||||
- Contain all entries
|
||||
* FormInputMetadata:
|
||||
- Store infos and options about an input.
|
||||
* FormInput:
|
||||
- Associaite a key, to a validator and metadata.
|
||||
* FormData: *collection of inputs*
|
||||
- Contain all inputs
|
||||
- Basic set operation
|
||||
|
||||
- FormDataCubit
|
||||
* Data management behind a form.
|
||||
- Use entries to pass a FormData object
|
||||
- You can use several pre configured FormInput for validation
|
||||
- You can use updateFormData() to change FormData and validators during runtime (intersection, union, difference or replace)
|
||||
- You can use several pre configured `FormInputValidator` for validation
|
||||
- You can use updateFormData() to change `FormData` during runtime (intersection, union, difference or replace)
|
||||
|
||||
- Consistent
|
||||
* Every class have same naming convention
|
||||
@@ -59,4 +60,120 @@ import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
|
||||
|
||||
## Usage
|
||||
|
||||
todo
|
||||
Firstly, you have to create your form inputs.
|
||||
|
||||
```dart
|
||||
static List<FormInput> getNormalEntries() {
|
||||
return const [
|
||||
FormInput(formFieldName, Name.pure()),
|
||||
FormInput(formFieldEmail, Email.pure()),
|
||||
FormInput(formFieldPhone, Phone.pure()),
|
||||
FormInput(formFieldList, ListOption<String>.pure(defaultValue: ['checkbox3'])),
|
||||
FormInput(formFieldRadio, TextString.pure()),
|
||||
FormInput(formFieldPro, Boolean.pure(), metadata: FormInputMetadata<void>(name: 'business')),
|
||||
FormInput(formFieldHidden, Boolean.pure(), metadata: FormInputMetadata<void>(export: false)),
|
||||
];
|
||||
}
|
||||
|
||||
static List<FormInput> getBusinessEntries() {
|
||||
const entries = [
|
||||
FormInput(formFieldSiren, Siren.pure()),
|
||||
FormInput(formFieldIban, Iban.pure()),
|
||||
];
|
||||
return getNormalEntries() + entries;
|
||||
}
|
||||
|
||||
static FormData getNormalFormData() {
|
||||
return FormData(getNormalEntries());
|
||||
}
|
||||
|
||||
static FormData getProFormData() {
|
||||
return FormData(getBusinessEntries());
|
||||
}
|
||||
```
|
||||
|
||||
> Let's create functions to enable dynamic changes in runtime.
|
||||
|
||||
> When creating metadata with `FormInputMetadata<T>`, `T` is the type of `extra` object.
|
||||
|
||||
Then a `FormData` is a collection of inputs. You can `validate`, `contains`, `intersection`, `difference`, `union`, or `clone` this data.
|
||||
|
||||
After that, you have to extends `FormDataCubit`.
|
||||
|
||||
```dart
|
||||
class CustomFormCubit extends FormDataCubit {
|
||||
CustomFormCubit({required FormData inputs}) : super(inputs: inputs);
|
||||
|
||||
@override
|
||||
Future<void> submitForm() {
|
||||
log(state.data.toMap().toString());
|
||||
// Handle all your logic here.
|
||||
emit(...)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> The submited form is in `state.data` !
|
||||
|
||||
Don't forget to create and provide it !
|
||||
|
||||
```dart
|
||||
FormDataCubit _formCubit = CustomFormCubit(inputs: getNormalFormData());
|
||||
|
||||
return BlocProvider(
|
||||
create: (context) => _formCubit,
|
||||
child: const WidgetTree(),
|
||||
);
|
||||
```
|
||||
|
||||
You can now create the first form input !
|
||||
|
||||
```dart
|
||||
class _EmailInput extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: (context, state) {
|
||||
return TextField(
|
||||
onChanged: (email) => context
|
||||
.read<FormDataCubit>()
|
||||
.dataChanged(formFieldEmail, Email.dirty(email)),
|
||||
keyboardType: TextInputType.emailAddress,
|
||||
decoration: InputDecoration(
|
||||
labelText: 'email',
|
||||
helperText: '',
|
||||
errorText: state.data.isNotValid(formFieldEmail)
|
||||
? 'invalid email'
|
||||
: null,
|
||||
),
|
||||
);
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Then, you can create the trigger
|
||||
|
||||
```dart
|
||||
class _SignUpButton extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
buildWhen: (previous, current) => previous.status != current.status,
|
||||
builder: (context, state) {
|
||||
return state.status.isSubmissionInProgress
|
||||
? const CircularProgressIndicator()
|
||||
: ElevatedButton(
|
||||
onPressed: state.status.isValidated
|
||||
? () => context.read<FormDataCubit>().submitForm()
|
||||
: null,
|
||||
child: const Text('SIGN UP'),
|
||||
);
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> With `state.status` you can access the status of the form to check if there is an error or if it's in submission.
|
||||
@@ -1 +1,4 @@
|
||||
include: package:wyatt_analysis/analysis_options.yaml
|
||||
|
||||
analyzer:
|
||||
exclude: "!example/**"
|
||||
@@ -1,10 +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 and should not be manually edited.
|
||||
# This file should be version controlled.
|
||||
|
||||
version:
|
||||
revision: 5464c5bac742001448fe4fc0597be939379f88ea
|
||||
revision: 85684f9300908116a78138ea4c6036c35c9a1236
|
||||
channel: stable
|
||||
|
||||
project_type: app
|
||||
|
||||
# Tracks metadata for the flutter migrate command
|
||||
migration:
|
||||
platforms:
|
||||
- platform: root
|
||||
create_revision: 85684f9300908116a78138ea4c6036c35c9a1236
|
||||
base_revision: 85684f9300908116a78138ea4c6036c35c9a1236
|
||||
- platform: web
|
||||
create_revision: 85684f9300908116a78138ea4c6036c35c9a1236
|
||||
base_revision: 85684f9300908116a78138ea4c6036c35c9a1236
|
||||
|
||||
# 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'
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
## 1.1.0
|
||||
|
||||
- **FEAT**: add list option validator.
|
||||
- **DOCS**: add example app.
|
||||
|
||||
@@ -16,31 +16,37 @@
|
||||
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
import 'package:form_bloc_example/app/metadata.dart';
|
||||
import 'package:form_bloc_example/constants.dart';
|
||||
import 'package:form_bloc_example/cubit/custom_form_cubit.dart';
|
||||
import 'package:form_bloc_example/sign_up/sign_up_page.dart';
|
||||
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
|
||||
|
||||
const blue = Metadata(category: Category.perso);
|
||||
const red = Metadata(category: Category.business);
|
||||
|
||||
class App extends StatelessWidget {
|
||||
const App({Key? key}) : super(key: key);
|
||||
|
||||
static List<FormEntry> getNormalEntries() {
|
||||
static List<FormInput> getNormalEntries() {
|
||||
return const [
|
||||
FormEntry(formFieldName, Name.pure()),
|
||||
FormEntry(formFieldEmail, Email.pure()),
|
||||
FormEntry(formFieldPhone, Phone.pure()),
|
||||
FormEntry(
|
||||
FormInput(formFieldName, Name.pure(), metadata: FormInputMetadata<Metadata>(extra: blue)),
|
||||
FormInput(formFieldEmail, Email.pure(), metadata: FormInputMetadata<Metadata>(extra: blue)),
|
||||
FormInput(formFieldPhone, Phone.pure(), metadata: FormInputMetadata<Metadata>(extra: red)),
|
||||
FormInput(
|
||||
formFieldList, ListOption<String>.pure(defaultValue: ['checkbox3'])),
|
||||
FormEntry(formFieldRadio, TextString.pure()),
|
||||
FormEntry(formFieldPro, Boolean.pure(), name: 'business'),
|
||||
FormEntry(formFieldHidden, Boolean.pure(), export: false),
|
||||
FormInput(formFieldRadio, TextString.pure()),
|
||||
FormInput(formFieldPro, Boolean.pure(),
|
||||
metadata: FormInputMetadata<Metadata>(name: 'business')),
|
||||
FormInput(formFieldHidden, Boolean.pure(),
|
||||
metadata: FormInputMetadata<Metadata>(export: false, extra: blue)),
|
||||
];
|
||||
}
|
||||
|
||||
static List<FormEntry> getBusinessEntries() {
|
||||
static List<FormInput> getBusinessEntries() {
|
||||
const entries = [
|
||||
FormEntry(formFieldSiren, Siren.pure()),
|
||||
FormEntry(formFieldIban, Iban.pure()),
|
||||
FormInput(formFieldSiren, Siren.pure()),
|
||||
FormInput(formFieldIban, Iban.pure()),
|
||||
];
|
||||
return getNormalEntries() + entries;
|
||||
}
|
||||
@@ -55,10 +61,10 @@ class App extends StatelessWidget {
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
FormDataCubit _formCubit = CustomFormCubit(entries: getNormalFormData());
|
||||
FormDataCubit formCubit = CustomFormCubit(inputs: getNormalFormData());
|
||||
|
||||
return BlocProvider(
|
||||
create: (context) => _formCubit,
|
||||
create: (context) => formCubit,
|
||||
child: const WidgetTree(),
|
||||
);
|
||||
}
|
||||
|
||||
+16
-7
@@ -1,3 +1,4 @@
|
||||
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
@@ -14,12 +15,20 @@
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
bool listEquals<T>(List<T>? a, List<T>? b) {
|
||||
if (a == null) return b == null;
|
||||
if (b == null || a.length != b.length) return false;
|
||||
if (identical(a, b)) return true;
|
||||
for (int index = 0; index < a.length; index += 1) {
|
||||
if (a[index] != b[index]) return false;
|
||||
enum Category {
|
||||
perso,
|
||||
business
|
||||
}
|
||||
|
||||
class Metadata {
|
||||
final Category category;
|
||||
|
||||
const Metadata({
|
||||
required this.category,
|
||||
});
|
||||
|
||||
@override
|
||||
String toString() {
|
||||
return category.toString();
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -16,13 +16,10 @@
|
||||
|
||||
import 'dart:developer';
|
||||
|
||||
import 'package:meta/meta.dart';
|
||||
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
|
||||
|
||||
part 'custom_form_state.dart';
|
||||
|
||||
class CustomFormCubit extends FormDataCubit {
|
||||
CustomFormCubit({required FormData entries}) : super(entries: entries);
|
||||
CustomFormCubit({required FormData inputs}) : super(inputs: inputs);
|
||||
|
||||
@override
|
||||
Future<void> submitForm() {
|
||||
|
||||
@@ -19,13 +19,61 @@ import 'dart:developer';
|
||||
import 'package:flutter/material.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
import 'package:form_bloc_example/app/app.dart';
|
||||
import 'package:form_bloc_example/app/metadata.dart';
|
||||
import 'package:form_bloc_example/constants.dart';
|
||||
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
|
||||
|
||||
class CategoryIndicator extends StatelessWidget {
|
||||
const CategoryIndicator(
|
||||
{Key? key, required this.field, required this.builder})
|
||||
: super(key: key);
|
||||
|
||||
final String field;
|
||||
final Function(BuildContext context, FormDataState state) builder;
|
||||
|
||||
Color computeColor(Metadata meta) {
|
||||
switch (meta.category) {
|
||||
case Category.perso:
|
||||
return Colors.blue;
|
||||
case Category.business:
|
||||
return Colors.red;
|
||||
}
|
||||
}
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: ((context, state) {
|
||||
final meta = state.data.metadataOf(field).extra as Metadata;
|
||||
final color = computeColor(meta);
|
||||
|
||||
return Row(
|
||||
children: [
|
||||
Container(
|
||||
height: 8,
|
||||
width: 8,
|
||||
decoration: BoxDecoration(
|
||||
color: color,
|
||||
borderRadius: BorderRadius.circular(8),
|
||||
),
|
||||
),
|
||||
const SizedBox(width: 20,),
|
||||
SizedBox(
|
||||
width: MediaQuery.of(context).size.width - 45,
|
||||
child: builder(context, state),
|
||||
)
|
||||
],
|
||||
);
|
||||
}),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class _NameInput extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
return CategoryIndicator(
|
||||
field: formFieldName,
|
||||
builder: (context, state) {
|
||||
return TextField(
|
||||
onChanged: (name) => context
|
||||
@@ -36,18 +84,18 @@ class _NameInput extends StatelessWidget {
|
||||
labelText: 'name',
|
||||
helperText: '',
|
||||
errorText:
|
||||
state.data.input(formFieldName).invalid ? 'invalid name' : null,
|
||||
state.data.isNotValid(formFieldName) ? 'invalid name' : null,
|
||||
),
|
||||
);
|
||||
},
|
||||
);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
class _EmailInput extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
return CategoryIndicator(
|
||||
field: formFieldEmail,
|
||||
builder: (context, state) {
|
||||
return TextField(
|
||||
onChanged: (email) => context
|
||||
@@ -57,9 +105,8 @@ class _EmailInput extends StatelessWidget {
|
||||
decoration: InputDecoration(
|
||||
labelText: 'email',
|
||||
helperText: '',
|
||||
errorText: state.data.input(formFieldEmail).invalid
|
||||
? 'invalid email'
|
||||
: null,
|
||||
errorText:
|
||||
state.data.isNotValid(formFieldEmail) ? 'invalid email' : null,
|
||||
),
|
||||
);
|
||||
},
|
||||
@@ -70,7 +117,8 @@ class _EmailInput extends StatelessWidget {
|
||||
class _PhoneInput extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
return CategoryIndicator(
|
||||
field: formFieldPhone,
|
||||
builder: (context, state) {
|
||||
return TextField(
|
||||
onChanged: (phone) => context
|
||||
@@ -80,9 +128,8 @@ class _PhoneInput extends StatelessWidget {
|
||||
decoration: InputDecoration(
|
||||
labelText: 'phone',
|
||||
helperText: '',
|
||||
errorText: state.data.input(formFieldPhone).invalid
|
||||
? 'invalid phone'
|
||||
: null,
|
||||
errorText:
|
||||
state.data.isNotValid(formFieldPhone) ? 'invalid phone' : null,
|
||||
),
|
||||
);
|
||||
},
|
||||
@@ -93,7 +140,8 @@ class _PhoneInput extends StatelessWidget {
|
||||
class _SirenInput extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
return CategoryIndicator(
|
||||
field: formFieldName,
|
||||
builder: (context, state) {
|
||||
return TextField(
|
||||
onChanged: (siren) => context
|
||||
@@ -103,9 +151,8 @@ class _SirenInput extends StatelessWidget {
|
||||
decoration: InputDecoration(
|
||||
labelText: 'siren',
|
||||
helperText: '',
|
||||
errorText: state.data.input(formFieldSiren).invalid
|
||||
? 'invalid SIREN'
|
||||
: null,
|
||||
errorText:
|
||||
state.data.isNotValid(formFieldSiren) ? 'invalid SIREN' : null,
|
||||
),
|
||||
);
|
||||
},
|
||||
@@ -127,7 +174,7 @@ class _IbanInput extends StatelessWidget {
|
||||
labelText: 'iban',
|
||||
helperText: '',
|
||||
errorText:
|
||||
state.data.input(formFieldIban).invalid ? 'invalid IBAN' : null,
|
||||
state.data.isNotValid(formFieldIban) ? 'invalid IBAN' : null,
|
||||
),
|
||||
);
|
||||
},
|
||||
@@ -140,9 +187,9 @@ class _CheckListInput extends StatelessWidget {
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: (context, state) {
|
||||
final _input =
|
||||
state.data.input<List<String>>(formFieldList) as ListOption<String>;
|
||||
final _options = _input.value;
|
||||
final input =
|
||||
state.data.validatorOf<ListOption<String>>(formFieldList);
|
||||
final options = input.value;
|
||||
|
||||
return Column(
|
||||
mainAxisSize: MainAxisSize.min,
|
||||
@@ -150,33 +197,33 @@ class _CheckListInput extends StatelessWidget {
|
||||
ListTile(
|
||||
title: const Text('Checkbox1'),
|
||||
trailing: Checkbox(
|
||||
value: _options.contains('checkbox1'),
|
||||
value: options.contains('checkbox1'),
|
||||
onChanged: (_) {
|
||||
context.read<FormDataCubit>().dataChanged(
|
||||
formFieldList,
|
||||
_input.select('checkbox1'),
|
||||
input.select('checkbox1'),
|
||||
);
|
||||
}),
|
||||
),
|
||||
ListTile(
|
||||
title: const Text('Checkbox2'),
|
||||
trailing: Checkbox(
|
||||
value: _options.contains('checkbox2'),
|
||||
value: options.contains('checkbox2'),
|
||||
onChanged: (_) {
|
||||
context.read<FormDataCubit>().dataChanged(
|
||||
formFieldList,
|
||||
_input.select('checkbox2'),
|
||||
input.select('checkbox2'),
|
||||
);
|
||||
}),
|
||||
),
|
||||
ListTile(
|
||||
title: const Text('Checkbox3 (default)'),
|
||||
trailing: Checkbox(
|
||||
value: _options.contains('checkbox3'),
|
||||
value: options.contains('checkbox3'),
|
||||
onChanged: (_) {
|
||||
context.read<FormDataCubit>().dataChanged(
|
||||
formFieldList,
|
||||
_input.select('checkbox3'),
|
||||
input.select('checkbox3'),
|
||||
);
|
||||
}),
|
||||
),
|
||||
@@ -192,8 +239,7 @@ class _RadioListInput extends StatelessWidget {
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: (context, state) {
|
||||
final _input =
|
||||
state.data.input<String>(formFieldRadio) as TextString;
|
||||
final input = state.data.validatorOf<TextString>(formFieldRadio);
|
||||
|
||||
return Column(
|
||||
mainAxisSize: MainAxisSize.min,
|
||||
@@ -202,7 +248,7 @@ class _RadioListInput extends StatelessWidget {
|
||||
title: const Text('Radio1'),
|
||||
trailing: Radio<bool>(
|
||||
groupValue: true,
|
||||
value: _input.value == 'radio1',
|
||||
value: input.value == 'radio1',
|
||||
onChanged: (_) {
|
||||
context.read<FormDataCubit>().dataChanged(
|
||||
formFieldRadio,
|
||||
@@ -214,7 +260,7 @@ class _RadioListInput extends StatelessWidget {
|
||||
title: const Text('Radio2'),
|
||||
trailing: Radio<bool>(
|
||||
groupValue: true,
|
||||
value: _input.value == 'radio2',
|
||||
value: input.value == 'radio2',
|
||||
onChanged: (_) {
|
||||
context.read<FormDataCubit>().dataChanged(
|
||||
formFieldRadio,
|
||||
@@ -226,7 +272,7 @@ class _RadioListInput extends StatelessWidget {
|
||||
title: const Text('Radio3'),
|
||||
trailing: Radio<bool>(
|
||||
groupValue: true,
|
||||
value: _input.value == 'radio3',
|
||||
value: input.value == 'radio3',
|
||||
onChanged: (_) {
|
||||
context.read<FormDataCubit>().dataChanged(
|
||||
formFieldRadio,
|
||||
@@ -249,7 +295,7 @@ class _CheckHiddenInput extends StatelessWidget {
|
||||
trailing: BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: (context, state) {
|
||||
return Checkbox(
|
||||
value: state.data.input<bool>(formFieldHidden).value,
|
||||
value: state.data.validatorOf<Boolean>(formFieldHidden).value,
|
||||
onChanged: (v) {
|
||||
final value = v!; // state is false, so value can't be null
|
||||
|
||||
@@ -272,7 +318,7 @@ class _CheckIsProInput extends StatelessWidget {
|
||||
trailing: BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: (context, state) {
|
||||
return Checkbox(
|
||||
value: state.data.input<bool>(formFieldPro).value,
|
||||
value: state.data.validatorOf<Boolean>(formFieldPro).value,
|
||||
onChanged: (isPro) {
|
||||
final value = isPro!; // state is false, so value can't be null
|
||||
|
||||
@@ -332,6 +378,20 @@ class _DebugButton extends StatelessWidget {
|
||||
}
|
||||
}
|
||||
|
||||
class _ResetButton extends StatelessWidget {
|
||||
@override
|
||||
Widget build(BuildContext context) {
|
||||
return BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: (context, state) {
|
||||
return ElevatedButton(
|
||||
onPressed: () => context.read<FormDataCubit>().resetForm(),
|
||||
child: const Text('RESET'),
|
||||
);
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
class SignUpForm extends StatelessWidget {
|
||||
const SignUpForm({Key? key}) : super(key: key);
|
||||
|
||||
@@ -370,7 +430,7 @@ class SignUpForm extends StatelessWidget {
|
||||
const SizedBox(height: 8),
|
||||
BlocBuilder<FormDataCubit, FormDataState>(
|
||||
builder: (context, state) {
|
||||
if (state.data.input<bool>(formFieldPro).value) {
|
||||
if (state.data.validatorOf<Boolean>(formFieldPro).value) {
|
||||
return Column(children: [
|
||||
_SirenInput(),
|
||||
const SizedBox(height: 8),
|
||||
@@ -385,6 +445,8 @@ class SignUpForm extends StatelessWidget {
|
||||
_SignUpButton(),
|
||||
const SizedBox(height: 8),
|
||||
_DebugButton(),
|
||||
const SizedBox(height: 8),
|
||||
_ResetButton(),
|
||||
],
|
||||
),
|
||||
),
|
||||
|
||||
@@ -15,10 +15,10 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev
|
||||
# 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
|
||||
version: 1.1.0
|
||||
|
||||
environment:
|
||||
sdk: ">=2.16.2 <3.0.0"
|
||||
sdk: ">=2.17.2 <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
|
||||
@@ -47,7 +47,7 @@ dev_dependencies:
|
||||
# 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: ^1.0.0
|
||||
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
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 917 B |
Binary file not shown.
|
After Width: | Height: | Size: 5.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 5.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
@@ -0,0 +1,58 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<!--
|
||||
If you are serving your web app in a path other than the root, change the
|
||||
href value below to reflect the base path you are serving from.
|
||||
|
||||
The path provided below has to start and end with a slash "/" in order for
|
||||
it to work correctly.
|
||||
|
||||
For more details:
|
||||
* https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base
|
||||
|
||||
This is a placeholder for base href that will be replaced by the value of
|
||||
the `--base-href` argument provided to `flutter build`.
|
||||
-->
|
||||
<base href="$FLUTTER_BASE_HREF">
|
||||
|
||||
<meta charset="UTF-8">
|
||||
<meta content="IE=Edge" http-equiv="X-UA-Compatible">
|
||||
<meta name="description" content="A new Flutter project.">
|
||||
|
||||
<!-- iOS meta tags & icons -->
|
||||
<meta name="apple-mobile-web-app-capable" content="yes">
|
||||
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
||||
<meta name="apple-mobile-web-app-title" content="example">
|
||||
<link rel="apple-touch-icon" href="icons/Icon-192.png">
|
||||
|
||||
<!-- Favicon -->
|
||||
<link rel="icon" type="image/png" href="favicon.png"/>
|
||||
|
||||
<title>example</title>
|
||||
<link rel="manifest" href="manifest.json">
|
||||
|
||||
<script>
|
||||
// The value below is injected by flutter build, do not touch.
|
||||
var serviceWorkerVersion = null;
|
||||
</script>
|
||||
<!-- This script adds the flutter initialization JS code -->
|
||||
<script src="flutter.js" defer></script>
|
||||
</head>
|
||||
<body>
|
||||
<script>
|
||||
window.addEventListener('load', function(ev) {
|
||||
// Download main.dart.js
|
||||
_flutter.loader.loadEntrypoint({
|
||||
serviceWorker: {
|
||||
serviceWorkerVersion: serviceWorkerVersion,
|
||||
}
|
||||
}).then(function(engineInitializer) {
|
||||
return engineInitializer.initializeEngine();
|
||||
}).then(function(appRunner) {
|
||||
return appRunner.runApp();
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"name": "example",
|
||||
"short_name": "example",
|
||||
"start_url": ".",
|
||||
"display": "standalone",
|
||||
"background_color": "#0175C2",
|
||||
"theme_color": "#0175C2",
|
||||
"description": "A new Flutter project.",
|
||||
"orientation": "portrait-primary",
|
||||
"prefer_related_applications": false,
|
||||
"icons": [
|
||||
{
|
||||
"src": "icons/Icon-192.png",
|
||||
"sizes": "192x192",
|
||||
"type": "image/png"
|
||||
},
|
||||
{
|
||||
"src": "icons/Icon-512.png",
|
||||
"sizes": "512x512",
|
||||
"type": "image/png"
|
||||
},
|
||||
{
|
||||
"src": "icons/Icon-maskable-192.png",
|
||||
"sizes": "192x192",
|
||||
"type": "image/png",
|
||||
"purpose": "maskable"
|
||||
},
|
||||
{
|
||||
"src": "icons/Icon-maskable-512.png",
|
||||
"sizes": "512x512",
|
||||
"type": "image/png",
|
||||
"purpose": "maskable"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -17,38 +17,55 @@
|
||||
import 'dart:async';
|
||||
|
||||
import 'package:bloc/bloc.dart';
|
||||
import 'package:meta/meta.dart';
|
||||
import 'package:equatable/equatable.dart';
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/form/every_input_validator.dart';
|
||||
|
||||
part 'form_data_state.dart';
|
||||
|
||||
abstract class FormDataCubit extends Cubit<FormDataState> {
|
||||
FormDataCubit({required FormData entries})
|
||||
: super(FormDataState(data: entries));
|
||||
FormValidator validationStrategy;
|
||||
FormData formCopy;
|
||||
|
||||
FormDataCubit({
|
||||
required FormData inputs,
|
||||
FormValidator validator = const EveryInputValidator(),
|
||||
}) : formCopy = inputs.clone(),
|
||||
validationStrategy = validator,
|
||||
super(FormDataState(data: inputs));
|
||||
|
||||
/// Change value of a field.
|
||||
///
|
||||
/// Inputs:
|
||||
/// - `field`: The key of the field to change.
|
||||
/// - `dirtyValue`: The new value of the field.
|
||||
void dataChanged(String field, FormInput dirtyValue) {
|
||||
final _form = state.data.clone();
|
||||
/// - `dirtyValue`: The new value of the field. (Wrapped in a dirty validator)
|
||||
void dataChanged<V>(
|
||||
String field,
|
||||
FormInputValidator<V, ValidationError> dirtyValue,
|
||||
) {
|
||||
final form = state.data.clone();
|
||||
|
||||
if (_form.contains(field)) {
|
||||
_form.update(field, dirtyValue);
|
||||
if (form.contains(field)) {
|
||||
form.updateValidator(field, dirtyValue);
|
||||
} else {
|
||||
throw Exception('Form field $field not found');
|
||||
}
|
||||
|
||||
emit(
|
||||
state.copyWith(
|
||||
data: _form,
|
||||
status: _form.selfValidate(),
|
||||
data: form,
|
||||
status: validationStrategy.validate(form),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/// Just validate the form manually. (Useful if you just update the strategy)
|
||||
void validate() {
|
||||
final form = state.data;
|
||||
emit(state.copyWith(status: validationStrategy.validate(form)));
|
||||
}
|
||||
|
||||
/// Update entries list.
|
||||
///
|
||||
/// Inputs:
|
||||
@@ -58,31 +75,36 @@ abstract class FormDataCubit extends Cubit<FormDataState> {
|
||||
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: _form.selfValidate(),
|
||||
data: form,
|
||||
status: validationStrategy.validate(form),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/// Reset all form inputs
|
||||
void resetForm() {
|
||||
emit(FormDataState(data: formCopy));
|
||||
}
|
||||
|
||||
/// Submit the form.
|
||||
Future<void> submitForm();
|
||||
}
|
||||
|
||||
@@ -16,10 +16,14 @@
|
||||
|
||||
part of 'form_data_cubit.dart';
|
||||
|
||||
@immutable
|
||||
class FormDataState {
|
||||
class FormDataState extends Equatable {
|
||||
/// Global status of a form.
|
||||
final FormStatus status;
|
||||
|
||||
/// FormData with all inputs, and associated metadata.
|
||||
final FormData data;
|
||||
|
||||
/// Optional error message.
|
||||
final String? errorMessage;
|
||||
|
||||
const FormDataState({
|
||||
@@ -32,32 +36,15 @@ class FormDataState {
|
||||
FormStatus? status,
|
||||
FormData? data,
|
||||
String? errorMessage,
|
||||
}) {
|
||||
return FormDataState(
|
||||
}) => FormDataState(
|
||||
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 FormDataState &&
|
||||
other.status == status &&
|
||||
other.data == data &&
|
||||
other.errorMessage == errorMessage;
|
||||
}
|
||||
bool? get stringify => true;
|
||||
|
||||
@override
|
||||
int get hashCode {
|
||||
return status.hashCode ^ data.hashCode ^ errorMessage.hashCode;
|
||||
}
|
||||
|
||||
@override
|
||||
String toString() {
|
||||
return 'FormDataState(status: $status, data: $data, '
|
||||
'errorMessage: $errorMessage)';
|
||||
}
|
||||
List<Object?> get props => [status, data, errorMessage];
|
||||
}
|
||||
|
||||
@@ -14,6 +14,14 @@
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
const Set<FormStatus> _validatedFormStatuses = <FormStatus>{
|
||||
FormStatus.valid,
|
||||
FormStatus.submissionInProgress,
|
||||
FormStatus.submissionSuccess,
|
||||
FormStatus.submissionFailure,
|
||||
FormStatus.submissionCanceled,
|
||||
};
|
||||
|
||||
/// Enum representing the status of a form at any given point in time.
|
||||
enum FormStatus {
|
||||
/// The form has not been touched.
|
||||
@@ -35,23 +43,14 @@ enum FormStatus {
|
||||
submissionFailure,
|
||||
|
||||
/// The form submission has been canceled.
|
||||
submissionCanceled
|
||||
}
|
||||
submissionCanceled;
|
||||
|
||||
const Set<FormStatus> _validatedFormStatuses = <FormStatus>{
|
||||
FormStatus.valid,
|
||||
FormStatus.submissionInProgress,
|
||||
FormStatus.submissionSuccess,
|
||||
FormStatus.submissionFailure,
|
||||
FormStatus.submissionCanceled,
|
||||
};
|
||||
|
||||
/// Useful extensions on [FormStatus]
|
||||
extension FormStatusX on FormStatus {
|
||||
/// Indicates whether the form is untouched.
|
||||
bool get isPure => this == FormStatus.pure;
|
||||
|
||||
/// Indicates whether the form is completely validated.
|
||||
/// This means the [FormStatus] is strictly:
|
||||
/// * `FormStatus.valid`
|
||||
bool get isValid => this == FormStatus.valid;
|
||||
|
||||
/// Indicates whether the form has been validated successfully.
|
||||
|
||||
@@ -14,7 +14,14 @@
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
enum ValidationError {
|
||||
/// Generic invalid error.
|
||||
invalid
|
||||
// enum ValidationError {
|
||||
// /// Generic invalid error.
|
||||
// invalid
|
||||
// }
|
||||
|
||||
abstract class ValidationError {}
|
||||
|
||||
enum ValidationStandardError implements ValidationError {
|
||||
invalid,
|
||||
empty
|
||||
}
|
||||
|
||||
@@ -14,6 +14,15 @@
|
||||
// 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_data.dart';
|
||||
export 'form_entry.dart';
|
||||
export 'form_input.dart';
|
||||
import 'dart:convert';
|
||||
|
||||
import 'package:equatable/equatable.dart';
|
||||
import 'package:wyatt_form_bloc/src/enums/form_input_status.dart';
|
||||
import 'package:wyatt_form_bloc/src/enums/form_status.dart';
|
||||
import 'package:wyatt_form_bloc/src/enums/validation_error.dart';
|
||||
|
||||
part 'form_data.dart';
|
||||
part 'form_input.dart';
|
||||
part 'form_input_metadata.dart';
|
||||
part 'form_input_validator.dart';
|
||||
part 'form_validator.dart';
|
||||
|
||||
@@ -14,133 +14,171 @@
|
||||
// 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:meta/meta.dart';
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/utils/list_equals.dart';
|
||||
part of 'form.dart';
|
||||
|
||||
@immutable
|
||||
class FormData {
|
||||
const FormData(this._entries);
|
||||
class FormData extends Equatable {
|
||||
final List<FormInput> _inputs;
|
||||
|
||||
FormData.empty() : this(<FormEntry>[]);
|
||||
const FormData(this._inputs);
|
||||
const FormData.empty() : this(const <FormInput>[]);
|
||||
|
||||
final List<FormEntry> _entries;
|
||||
/// Returns all inputs as a list
|
||||
List<FormInput> inputs() => _inputs;
|
||||
|
||||
List<FormEntry> get entries => _entries;
|
||||
|
||||
List<FormInput<T, ValidationError>> inputs<T>() {
|
||||
return _entries
|
||||
.map((FormEntry entry) => entry.input as FormInput<T, ValidationError>)
|
||||
.toList();
|
||||
}
|
||||
|
||||
static FormStatus validate(List<FormInput> inputs) {
|
||||
return inputs.every((FormInput element) => element.pure)
|
||||
? FormStatus.pure
|
||||
: inputs.any((FormInput input) => input.valid == false)
|
||||
? FormStatus.invalid
|
||||
: FormStatus.valid;
|
||||
}
|
||||
|
||||
FormStatus selfValidate() {
|
||||
return validate(inputs<dynamic>());
|
||||
}
|
||||
|
||||
FormInput<T, ValidationError> input<T>(String key) {
|
||||
/// Returns the input for the associated key
|
||||
FormInput inputOf(String key) {
|
||||
if (contains(key)) {
|
||||
return _entries.firstWhere((FormEntry entry) => entry.key == key).input
|
||||
as FormInput<T, ValidationError>;
|
||||
return _inputs.firstWhere((input) => input.key == key);
|
||||
} else {
|
||||
throw Exception('FormInput with key `$key` does not exist in form');
|
||||
}
|
||||
}
|
||||
|
||||
bool contains(String key) {
|
||||
return _entries.any((FormEntry entry) => entry.key == key);
|
||||
}
|
||||
|
||||
FormData intersection(FormData other) {
|
||||
final List<FormEntry> entries = <FormEntry>[];
|
||||
|
||||
for (final FormEntry entry in _entries) {
|
||||
if (other.contains(entry.key)) {
|
||||
entries.add(entry);
|
||||
}
|
||||
}
|
||||
|
||||
return FormData(entries);
|
||||
}
|
||||
|
||||
FormData difference(FormData other) {
|
||||
final List<FormEntry> entries = <FormEntry>[];
|
||||
|
||||
for (final FormEntry otherEntry in other._entries) {
|
||||
if (!contains(otherEntry.key)) {
|
||||
entries.add(otherEntry);
|
||||
}
|
||||
}
|
||||
|
||||
for (final FormEntry entry in _entries) {
|
||||
if (!other.contains(entry.key)) {
|
||||
entries.add(entry);
|
||||
}
|
||||
}
|
||||
|
||||
return FormData(entries);
|
||||
}
|
||||
|
||||
FormData union(FormData other) {
|
||||
final List<FormEntry> entries = <FormEntry>[];
|
||||
|
||||
for (final FormEntry entry in _entries) {
|
||||
entries.add(entry);
|
||||
}
|
||||
|
||||
for (final FormEntry otherEntry in other._entries) {
|
||||
if (!contains(otherEntry.key)) {
|
||||
entries.add(otherEntry);
|
||||
}
|
||||
}
|
||||
|
||||
return FormData(entries);
|
||||
}
|
||||
|
||||
void update(String key, FormInput input) {
|
||||
/// Updates a input (perform a replace at index).
|
||||
void updateInput(String key, FormInput input) {
|
||||
if (contains(key)) {
|
||||
final index = _entries.indexOf(
|
||||
_entries.firstWhere((FormEntry entry) => entry.key == key),
|
||||
final index = _inputs.indexOf(
|
||||
inputOf(key),
|
||||
);
|
||||
_entries[index] = _entries[index].copyWith(input: input);
|
||||
_inputs[index] = input;
|
||||
}
|
||||
}
|
||||
|
||||
FormData clone() {
|
||||
return FormData(
|
||||
_entries.map((FormEntry entry) => entry.clone()).toList(),
|
||||
/// Returns all associated validators as a list
|
||||
List<FormInputValidator<V, E>> validators<V, E extends ValidationError>() =>
|
||||
_inputs
|
||||
.map<FormInputValidator<V, E>>(
|
||||
(input) => input.validator as FormInputValidator<V, E>,
|
||||
)
|
||||
.toList();
|
||||
|
||||
/// A [FormInputValidator] represents the value of a single form input field.
|
||||
/// It contains information about the [FormInputStatus], value, as well
|
||||
/// as validation status.
|
||||
T validatorOf<T>(String key) => inputOf(key).validator as T;
|
||||
|
||||
/// Updates validator of a given input. (perform copyWith)
|
||||
void updateValidator<V>(
|
||||
String key,
|
||||
FormInputValidator<V, ValidationError> dirtyValue,
|
||||
) {
|
||||
if (contains(key)) {
|
||||
final index = _inputs.indexOf(
|
||||
inputOf(key),
|
||||
);
|
||||
_inputs[index] = _inputs[index].copyWith(validator: dirtyValue);
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns a validation error if the [FormInputValidator] is invalid.
|
||||
/// Returns null if the [FormInputValidator] is valid.
|
||||
E? errorOf<E extends ValidationError>(String key) =>
|
||||
(inputOf(key).validator as FormInputValidator<dynamic, E>).error;
|
||||
|
||||
/// The value of the associated [FormInputValidator]. For example,
|
||||
/// if you have a FormInputValidator for FirstName, the value could be 'Joe'.
|
||||
V valueOf<V>(String key) =>
|
||||
(inputOf(key).validator as FormInputValidator<V, dynamic>).value;
|
||||
|
||||
/// Returns `true` if the [FormInputValidator] is not valid.
|
||||
/// Same as `E? errorOf<V, E>(String key) != null`
|
||||
bool isNotValid(String key) => !inputOf(key).validator.valid;
|
||||
|
||||
/// Returns all associated metadata as a list
|
||||
List<FormInputMetadata<M>> metadata<M>() => _inputs
|
||||
.map<FormInputMetadata<M>>(
|
||||
(input) => input.metadata as FormInputMetadata<M>,
|
||||
)
|
||||
.toList();
|
||||
|
||||
/// Returns the metadata associated. With `M` the type of extra data.
|
||||
FormInputMetadata<M> metadataOf<M>(String key) =>
|
||||
inputOf(key).metadata as FormInputMetadata<M>;
|
||||
|
||||
/// Updates metadata of a given input. (perform copyWith)
|
||||
void updateMetadata<M>(String key, FormInputMetadata<M> meta) {
|
||||
if (contains(key)) {
|
||||
final index = _inputs.indexOf(
|
||||
inputOf(key),
|
||||
);
|
||||
_inputs[index] = _inputs[index].copyWith(metadata: meta);
|
||||
}
|
||||
}
|
||||
|
||||
/// Check if this contains an input with the given key.
|
||||
bool contains(String key) => _inputs.any((input) => input.key == key);
|
||||
|
||||
/// Makes an intersection set operation and returns newly created [FormData]
|
||||
FormData intersection(FormData other) {
|
||||
final List<FormInput> inputs = <FormInput>[];
|
||||
|
||||
for (final FormInput i in _inputs) {
|
||||
if (other.contains(i.key)) {
|
||||
inputs.add(i);
|
||||
}
|
||||
}
|
||||
|
||||
return FormData(inputs);
|
||||
}
|
||||
|
||||
/// Makes a difference set operation and returns newly created [FormData]
|
||||
FormData difference(FormData other) {
|
||||
final List<FormInput> inputs = <FormInput>[];
|
||||
|
||||
for (final FormInput i in other._inputs) {
|
||||
if (!contains(i.key)) {
|
||||
inputs.add(i);
|
||||
}
|
||||
}
|
||||
|
||||
for (final FormInput i in _inputs) {
|
||||
if (!other.contains(i.key)) {
|
||||
inputs.add(i);
|
||||
}
|
||||
}
|
||||
|
||||
return FormData(inputs);
|
||||
}
|
||||
|
||||
/// Makes an union set operation and returns newly created [FormData]
|
||||
FormData union(FormData other) {
|
||||
final List<FormInput> inputs = <FormInput>[];
|
||||
|
||||
for (final FormInput i in _inputs) {
|
||||
inputs.add(i);
|
||||
}
|
||||
|
||||
for (final FormInput i in other._inputs) {
|
||||
if (!contains(i.key)) {
|
||||
inputs.add(i);
|
||||
}
|
||||
}
|
||||
|
||||
return FormData(inputs);
|
||||
}
|
||||
|
||||
/// Deeply copy this.
|
||||
FormData clone() => FormData(
|
||||
_inputs.map((input) => input.clone()).toList(),
|
||||
);
|
||||
|
||||
/// Export this to [Map] format.
|
||||
Map<String, dynamic> toMap() {
|
||||
final map = <String, dynamic>{};
|
||||
for (final entry in _entries) {
|
||||
if (entry.export) {
|
||||
map[entry.name] = entry.input.value;
|
||||
for (final input in _inputs) {
|
||||
if (input.metadata.export) {
|
||||
map[input.name] = input.validator.value;
|
||||
}
|
||||
}
|
||||
return map;
|
||||
}
|
||||
|
||||
@override
|
||||
bool operator ==(Object other) {
|
||||
if (identical(this, other)) return true;
|
||||
|
||||
return other is FormData && listEquals(other._entries, _entries);
|
||||
}
|
||||
/// Export this to [String] format.
|
||||
String toJson() => jsonEncode(toMap());
|
||||
|
||||
@override
|
||||
int get hashCode => _entries.hashCode;
|
||||
bool? get stringify => true;
|
||||
|
||||
@override
|
||||
String toString() => 'FormData(entries: $_entries)';
|
||||
List<Object?> get props => _inputs;
|
||||
}
|
||||
|
||||
@@ -1,79 +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 'package:meta/meta.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
|
||||
@immutable
|
||||
class FormEntry {
|
||||
const FormEntry(this.key, this.input, {this.export = true, String? name})
|
||||
: _field = name ?? key;
|
||||
|
||||
final String key;
|
||||
final FormInput input;
|
||||
final bool export;
|
||||
final String _field;
|
||||
|
||||
String get name => _field;
|
||||
|
||||
FormEntry copyWith({
|
||||
String? key,
|
||||
FormInput? input,
|
||||
bool? export,
|
||||
String? name,
|
||||
}) {
|
||||
return FormEntry(
|
||||
key ?? this.key,
|
||||
input ?? this.input,
|
||||
export: export ?? this.export,
|
||||
name: name,
|
||||
);
|
||||
}
|
||||
|
||||
FormEntry clone() {
|
||||
return FormEntry(
|
||||
key,
|
||||
input,
|
||||
export: export,
|
||||
name: name,
|
||||
);
|
||||
}
|
||||
|
||||
@override
|
||||
bool operator ==(Object other) {
|
||||
if (identical(this, other)) return true;
|
||||
|
||||
return other is FormEntry &&
|
||||
other.key == key &&
|
||||
other.input == input &&
|
||||
other.export == export &&
|
||||
other.name == name;
|
||||
}
|
||||
|
||||
@override
|
||||
int get hashCode {
|
||||
return key.hashCode ^
|
||||
input.hashCode ^
|
||||
export.hashCode ^
|
||||
name.hashCode;
|
||||
}
|
||||
|
||||
@override
|
||||
String toString() {
|
||||
return 'FormEntry(key: $key, input: $input, '
|
||||
'export: $export, name: $name)';
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,4 @@
|
||||
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
@@ -14,98 +15,42 @@
|
||||
// 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:meta/meta.dart';
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
part of 'form.dart';
|
||||
|
||||
/// {@template form_input}
|
||||
/// A [FormInput] represents the value of a single form input field.
|
||||
/// It contains information about the [FormInputStatus], [value], as well
|
||||
/// as validation status.
|
||||
///
|
||||
/// [FormInput] should be extended to define custom [FormInput] instances.
|
||||
///
|
||||
/// ```dart
|
||||
/// enum FirstNameError { empty }
|
||||
/// class FirstName extends FormInput<String, FirstNameError> {
|
||||
/// const FirstName.pure({String value = ''}) : super.pure(value);
|
||||
/// const FirstName.dirty({String value = ''}) : super.dirty(value);
|
||||
///
|
||||
/// @override
|
||||
/// FirstNameError? validator(String value) {
|
||||
/// return value.isEmpty ? FirstNameError.empty : null;
|
||||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
/// {@endtemplate}
|
||||
@immutable
|
||||
abstract class FormInput<T, E> {
|
||||
const FormInput._(this.value, [this.pure = true]);
|
||||
class FormInput<Validator extends FormInputValidator<dynamic, ValidationError>>
|
||||
extends Equatable {
|
||||
final String key;
|
||||
final Validator validator;
|
||||
final FormInputMetadata<dynamic> metadata;
|
||||
|
||||
/// Constructor which create a `pure` [FormInput] with a given value.
|
||||
const FormInput.pure(T value) : this._(value);
|
||||
String get name => metadata._name ?? key;
|
||||
|
||||
/// Constructor which create a `dirty` [FormInput] with a given value.
|
||||
const FormInput.dirty(T value) : this._(value, false);
|
||||
const FormInput(
|
||||
this.key,
|
||||
this.validator, {
|
||||
// ignore: avoid_redundant_argument_values
|
||||
this.metadata = const FormInputMetadata<void>(export: true),
|
||||
});
|
||||
|
||||
/// The value of the given [FormInput].
|
||||
/// For example, if you have a `FormInput` for `FirstName`,
|
||||
/// the value could be 'Joe'.
|
||||
final T value;
|
||||
FormInput copyWith({
|
||||
String? key,
|
||||
Validator? validator,
|
||||
FormInputMetadata? metadata,
|
||||
}) =>
|
||||
FormInput(
|
||||
key ?? this.key,
|
||||
validator ?? this.validator,
|
||||
metadata: metadata ?? this.metadata,
|
||||
);
|
||||
|
||||
/// If the [FormInput] is pure (has been touched/modified).
|
||||
/// Typically when the `FormInput` is initially created,
|
||||
/// it is created using the `FormInput.pure` constructor to
|
||||
/// signify that the user has not modified it.
|
||||
///
|
||||
/// For subsequent changes (in response to user input), the
|
||||
/// `FormInput.dirty` constructor should be used to signify that
|
||||
/// the `FormInput` has been manipulated.
|
||||
final bool pure;
|
||||
|
||||
/// The [FormInputStatus] which can be one of the following:
|
||||
/// * [FormInputStatus.pure]
|
||||
/// - if the input has not been modified.
|
||||
/// * [FormInputStatus.invalid]
|
||||
/// - if the input has been modified and validation failed.
|
||||
/// * [FormInputStatus.valid]
|
||||
/// - if the input has been modified and validation succeeded.
|
||||
FormInputStatus get status => pure
|
||||
? FormInputStatus.pure
|
||||
: valid
|
||||
? FormInputStatus.valid
|
||||
: FormInputStatus.invalid;
|
||||
|
||||
/// Returns a validation error if the [FormInput] is invalid.
|
||||
/// Returns `null` if the [FormInput] is valid.
|
||||
E? get error => validator(value);
|
||||
|
||||
/// Whether the [FormInput] value is valid according to the
|
||||
/// overridden `validator`.
|
||||
///
|
||||
/// Returns `true` if `validator` returns `null` for the
|
||||
/// current [FormInput] value and `false` otherwise.
|
||||
bool get valid => validator(value) == null;
|
||||
|
||||
/// Whether the [FormInput] value is not valid.
|
||||
/// A value is invalid when the overridden `validator`
|
||||
/// returns an error (non-null value).
|
||||
bool get invalid => status == FormInputStatus.invalid;
|
||||
|
||||
/// A function that must return a validation error if the provided
|
||||
/// [value] is invalid and `null` otherwise.
|
||||
E? validator(T value);
|
||||
FormInput clone() => copyWith(
|
||||
key: key,
|
||||
validator: validator,
|
||||
metadata: metadata,
|
||||
);
|
||||
@override
|
||||
bool? get stringify => true;
|
||||
|
||||
@override
|
||||
int get hashCode => value.hashCode ^ pure.hashCode;
|
||||
|
||||
@override
|
||||
bool operator ==(Object other) {
|
||||
if (other.runtimeType != runtimeType) return false;
|
||||
return other is FormInput<T, E> &&
|
||||
other.value == value &&
|
||||
other.pure == pure;
|
||||
}
|
||||
|
||||
@override
|
||||
String toString() => 'FormInput<$runtimeType>(value: $value, pure: $pure)';
|
||||
List<Object?> get props => [key, validator, metadata];
|
||||
}
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||
// 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 'form.dart';
|
||||
|
||||
class FormInputMetadata<T extends Object?> extends Equatable {
|
||||
final bool export;
|
||||
final String? _name;
|
||||
final T? extra;
|
||||
|
||||
const FormInputMetadata({
|
||||
this.export = true,
|
||||
this.extra,
|
||||
String? name,
|
||||
}) : _name = name;
|
||||
|
||||
FormInputMetadata<T> copyWith({
|
||||
bool? export,
|
||||
String? name,
|
||||
T? extra,
|
||||
}) =>
|
||||
FormInputMetadata<T>(
|
||||
export: export ?? this.export,
|
||||
name: name ?? _name,
|
||||
extra: extra ?? this.extra,
|
||||
);
|
||||
|
||||
FormInputMetadata<T> clone() => copyWith(
|
||||
export: export,
|
||||
name: _name,
|
||||
extra: extra,
|
||||
);
|
||||
|
||||
@override
|
||||
bool? get stringify => true;
|
||||
|
||||
@override
|
||||
List<Object?> get props => [export, _name, extra];
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
// 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 'form.dart';
|
||||
|
||||
/// {@template form_input_validator}
|
||||
/// A [FormInputValidator] represents the value of a single form input field.
|
||||
/// It contains information about the [FormInputStatus], [value], as well
|
||||
/// as validation status.
|
||||
///
|
||||
/// [FormInputValidator] should be extended to define custom
|
||||
/// [FormInputValidator] instances.
|
||||
///
|
||||
/// ```dart
|
||||
/// class Name extends FormInputValidator<String, ValidationStandardError> {
|
||||
/// const Name.pure({String value = ''}) : super.pure(value);
|
||||
/// const Name.dirty({String value = ''}) : super.dirty(value);
|
||||
///
|
||||
/// @override
|
||||
/// ValidationStandardError? validator(String? value) {
|
||||
/// if (value?.isEmpty ?? false) {
|
||||
/// return ValidationStandardError.empty
|
||||
/// }
|
||||
/// return value == null ? ValidationStandardError.invalid : null;
|
||||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
/// {@endtemplate}
|
||||
abstract class FormInputValidator<V, E extends ValidationError>
|
||||
extends Equatable {
|
||||
const FormInputValidator._(this.value, [this.pure = true]);
|
||||
|
||||
/// Constructor which create a `pure` [FormInputValidator] with a given value.
|
||||
const FormInputValidator.pure(V value) : this._(value);
|
||||
|
||||
/// Constructor which create a `dirty` [FormInputValidator] with a
|
||||
/// given value.
|
||||
const FormInputValidator.dirty(V value) : this._(value, false);
|
||||
|
||||
/// The value of the given [FormInputValidator].
|
||||
/// For example, if you have a `FormInputValidator` for `FirstName`,
|
||||
/// the value could be 'Joe'.
|
||||
final V value;
|
||||
|
||||
/// If the [FormInputValidator] is pure (has been touched/modified).
|
||||
/// Typically when the `FormInputValidator` is initially created,
|
||||
/// it is created using the `FormInputValidator.pure` constructor to
|
||||
/// signify that the user has not modified it.
|
||||
///
|
||||
/// For subsequent changes (in response to user input), the
|
||||
/// `FormInputValidator.dirty` constructor should be used to signify that
|
||||
/// the `FormInputValidator` has been manipulated.
|
||||
final bool pure;
|
||||
|
||||
/// The [FormInputStatus] which can be one of the following:
|
||||
/// * [FormInputStatus.pure]
|
||||
/// - if the input has not been modified.
|
||||
/// * [FormInputStatus.invalid]
|
||||
/// - if the input has been modified and validation failed.
|
||||
/// * [FormInputStatus.valid]
|
||||
/// - if the input has been modified and validation succeeded.
|
||||
FormInputStatus get status => pure
|
||||
? FormInputStatus.pure
|
||||
: valid
|
||||
? FormInputStatus.valid
|
||||
: FormInputStatus.invalid;
|
||||
|
||||
/// Returns a validation error if the [FormInputValidator] is invalid.
|
||||
/// Returns `null` if the [FormInputValidator] is valid.
|
||||
E? get error => validator(value);
|
||||
|
||||
/// Whether the [FormInputValidator] value is valid according to the
|
||||
/// overridden `validator`.
|
||||
///
|
||||
/// Returns `true` if `validator` returns `null` for the
|
||||
/// current [FormInputValidator] value and `false` otherwise.
|
||||
bool get valid => validator(value) == null;
|
||||
|
||||
/// Whether the [FormInputValidator] value is not valid.
|
||||
/// A value is invalid when the overridden `validator`
|
||||
/// returns an error (non-null value).
|
||||
bool get invalid => status == FormInputStatus.invalid;
|
||||
|
||||
/// A function that must return a validation error if the provided
|
||||
/// [value] is invalid and `null` otherwise.
|
||||
E? validator(V value);
|
||||
|
||||
@override
|
||||
bool? get stringify => true;
|
||||
|
||||
@override
|
||||
List<Object?> get props => [value, pure];
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// any later version.
|
||||
//
|
||||
// This program is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
part of 'form.dart';
|
||||
|
||||
/// {@template form_validator}
|
||||
/// A [FormValidator] represents the global validaton state of a Form.
|
||||
/// {@endtemplate}
|
||||
abstract class FormValidator {
|
||||
/// {@macro form_validator}
|
||||
const FormValidator();
|
||||
|
||||
bool isPure(FormData form) => form
|
||||
.validators<dynamic, ValidationError>()
|
||||
.every((validator) => validator.pure);
|
||||
|
||||
FormStatus validate(FormData form);
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
// 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:wyatt_form_bloc/wyatt_form_bloc.dart';
|
||||
|
||||
/// {@template every}
|
||||
/// Check and validate every input of a form
|
||||
/// {@endtemplate}
|
||||
class EveryInputValidator extends FormValidator {
|
||||
/// {@macro every}
|
||||
const EveryInputValidator() : super();
|
||||
|
||||
@override
|
||||
FormStatus validate(FormData form) {
|
||||
if (isPure(form)) {
|
||||
return FormStatus.pure;
|
||||
}
|
||||
|
||||
if (form
|
||||
.validators<dynamic, ValidationError>()
|
||||
.any((validator) => validator.valid == false)) {
|
||||
return FormStatus.invalid;
|
||||
}
|
||||
|
||||
return FormStatus.valid;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
// 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:wyatt_form_bloc/src/enums/validation_error.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
|
||||
/// {@template regex_validator}
|
||||
/// Abstract regex validator for form input.
|
||||
/// {@endtemplate}
|
||||
abstract class RegexValidator<E extends ValidationError>
|
||||
extends FormInputValidator<String, E> {
|
||||
const RegexValidator.pure() : super.pure('');
|
||||
const RegexValidator.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
RegExp get regex;
|
||||
/// If the value is **not** null, but empty.
|
||||
E get onEmpty;
|
||||
/// If value does not conform to regex.
|
||||
E get onError;
|
||||
|
||||
@override
|
||||
E? validator(String? value) {
|
||||
if (value?.isEmpty ?? false) {
|
||||
return onEmpty;
|
||||
}
|
||||
return regex.hasMatch(value ?? '') ? null : onError;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
// 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:wyatt_form_bloc/src/enums/validation_error.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
|
||||
abstract class TextValidator<E extends ValidationError>
|
||||
extends FormInputValidator<String, E> {
|
||||
const TextValidator.pure() : super.pure('');
|
||||
const TextValidator.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
/// If the value is **not** null, but empty.
|
||||
E get onEmpty;
|
||||
|
||||
/// If value is null.
|
||||
E get onNull;
|
||||
|
||||
@override
|
||||
E? validator(String? value) {
|
||||
if (value?.isEmpty ?? false) {
|
||||
return onEmpty;
|
||||
}
|
||||
return value != null ? null : onNull;
|
||||
}
|
||||
}
|
||||
+3
-4
@@ -20,7 +20,7 @@ import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
/// {@template boolean}
|
||||
/// Form input for a bool input
|
||||
/// {@endtemplate}
|
||||
class Boolean extends FormInput<bool, ValidationError> {
|
||||
class Boolean extends FormInputValidator<bool, ValidationStandardError> {
|
||||
/// {@macro boolean}
|
||||
const Boolean.pure({bool? defaultValue = false})
|
||||
: super.pure(defaultValue ?? false);
|
||||
@@ -29,7 +29,6 @@ class Boolean extends FormInput<bool, ValidationError> {
|
||||
const Boolean.dirty({bool value = false}) : super.dirty(value);
|
||||
|
||||
@override
|
||||
ValidationError? validator(bool? value) {
|
||||
return value != null ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError? validator(bool? value) =>
|
||||
value != null ? null : ValidationStandardError.invalid;
|
||||
}
|
||||
+3
-4
@@ -21,7 +21,7 @@ import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
/// Form input for a confirmed password input.
|
||||
/// {@endtemplate}
|
||||
class ConfirmedPassword
|
||||
extends FormInput<String, ValidationError> {
|
||||
extends FormInputValidator<String, ValidationStandardError> {
|
||||
/// {@macro confirmed_password}
|
||||
const ConfirmedPassword.pure({this.password = ''}) : super.pure('');
|
||||
|
||||
@@ -33,7 +33,6 @@ class ConfirmedPassword
|
||||
final String password;
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return password == value ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError? validator(String? value) =>
|
||||
password == value ? null : ValidationStandardError.invalid;
|
||||
}
|
||||
+12
-11
@@ -15,24 +15,25 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/regex_validator.dart';
|
||||
|
||||
/// {@template email}
|
||||
/// Form input for an email input.
|
||||
/// {@endtemplate}
|
||||
class Email extends FormInput<String, ValidationError> {
|
||||
class Email extends RegexValidator<ValidationStandardError> {
|
||||
/// {@macro email}
|
||||
const Email.pure() : super.pure('');
|
||||
const Email.pure() : super.pure();
|
||||
|
||||
/// {@macro email}
|
||||
const Email.dirty([String value = '']) : super.dirty(value);
|
||||
|
||||
static final RegExp _emailRegExp = RegExp(
|
||||
r'^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$',
|
||||
);
|
||||
const Email.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return _emailRegExp.hasMatch(value ?? '') ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
@override
|
||||
ValidationStandardError get onError => ValidationStandardError.invalid;
|
||||
|
||||
@override
|
||||
RegExp get regex => RegExp(
|
||||
r'[^@ \t\r\n]+@[^@ \t\r\n]+\.[^@ \t\r\n]+',
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
// 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:wyatt_form_bloc/src/enums/validation_error.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/text_validator.dart';
|
||||
|
||||
class EnumValidator<E> extends TextValidator<ValidationStandardError> {
|
||||
/// {@macro text_string}
|
||||
const EnumValidator.pure() : super.pure();
|
||||
|
||||
/// {@macro text_string}
|
||||
EnumValidator.dirty(E value) : super.dirty(value.toString());
|
||||
|
||||
@override
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
|
||||
@override
|
||||
ValidationStandardError get onNull => ValidationStandardError.invalid;
|
||||
}
|
||||
+12
-11
@@ -15,24 +15,25 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/regex_validator.dart';
|
||||
|
||||
/// {@template iban}
|
||||
/// Form input for an IBAN input.
|
||||
/// {@endtemplate}
|
||||
class Iban extends FormInput<String, ValidationError> {
|
||||
class Iban extends RegexValidator<ValidationStandardError> {
|
||||
/// {@macro iban}
|
||||
const Iban.pure() : super.pure('');
|
||||
const Iban.pure() : super.pure();
|
||||
|
||||
/// {@macro iban}
|
||||
const Iban.dirty([String value = '']) : super.dirty(value);
|
||||
|
||||
static final RegExp _regExp = RegExp(
|
||||
r'^(?:((?:IT|SM)\d{2}[A-Z]{1}\d{22})|(NL\d{2}[A-Z]{4}\d{10})|(LV\d{2}[A-Z]{4}\d{13})|((?:BG|GB|IE)\d{2}[A-Z]{4}\d{14})|(GI\d{2}[A-Z]{4}\d{15})|(RO\d{2}[A-Z]{4}\d{16})|(MT\d{2}[A-Z]{4}\d{23})|(NO\d{13})|((?:DK|FI)\d{16})|((?:SI)\d{17})|((?:AT|EE|LU|LT)\d{18})|((?:HR|LI|CH)\d{19})|((?:DE|VA)\d{20})|((?:AD|CZ|ES|MD|SK|SE)\d{22})|(PT\d{23})|((?:IS)\d{24})|((?:BE)\d{14})|((?:FR|MC|GR)\d{25})|((?:PL|HU|CY)\d{26}))$',
|
||||
);
|
||||
const Iban.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return _regExp.hasMatch(value ?? '') ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
@override
|
||||
ValidationStandardError get onError => ValidationStandardError.invalid;
|
||||
|
||||
@override
|
||||
RegExp get regex => RegExp(
|
||||
r'^(?:((?:IT|SM)\d{2}[A-Z]{1}\d{22})|(NL\d{2}[A-Z]{4}\d{10})|(LV\d{2}[A-Z]{4}\d{13})|((?:BG|GB|IE)\d{2}[A-Z]{4}\d{14})|(GI\d{2}[A-Z]{4}\d{15})|(RO\d{2}[A-Z]{4}\d{16})|(MT\d{2}[A-Z]{4}\d{23})|(NO\d{13})|((?:DK|FI)\d{16})|((?:SI)\d{17})|((?:AT|EE|LU|LT)\d{18})|((?:HR|LI|CH)\d{19})|((?:DE|VA)\d{20})|((?:AD|CZ|ES|MD|SK|SE)\d{22})|(PT\d{23})|((?:IS)\d{24})|((?:BE)\d{14})|((?:FR|MC|GR)\d{25})|((?:PL|HU|CY)\d{26}))$',
|
||||
);
|
||||
}
|
||||
+7
-5
@@ -20,7 +20,8 @@ import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
/// {@template list_option}
|
||||
/// Form input for a list input
|
||||
/// {@endtemplate}
|
||||
class ListOption<T> extends FormInput<List<T>, ValidationError> {
|
||||
class ListOption<T>
|
||||
extends FormInputValidator<List<T>, ValidationStandardError> {
|
||||
/// {@macro list_option}
|
||||
const ListOption.pure({List<T>? defaultValue})
|
||||
: super.pure(defaultValue ?? const []);
|
||||
@@ -28,7 +29,7 @@ class ListOption<T> extends FormInput<List<T>, ValidationError> {
|
||||
/// {@macro list_option}
|
||||
const ListOption.dirty({List<T>? value}) : super.dirty(value ?? const []);
|
||||
|
||||
ListOption select(T? v) {
|
||||
ListOption<T> select(T? v) {
|
||||
if (v == null) {
|
||||
return this;
|
||||
}
|
||||
@@ -42,7 +43,8 @@ class ListOption<T> extends FormInput<List<T>, ValidationError> {
|
||||
}
|
||||
|
||||
@override
|
||||
ValidationError? validator(List<T>? value) {
|
||||
return value?.isNotEmpty == true ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError? validator(List<T>? value) =>
|
||||
value?.isNotEmpty ?? false == true
|
||||
? null
|
||||
: ValidationStandardError.invalid;
|
||||
}
|
||||
+10
-9
@@ -15,22 +15,23 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/regex_validator.dart';
|
||||
|
||||
/// {@template name}
|
||||
/// Form input for a name input.
|
||||
/// {@endtemplate}
|
||||
class Name extends FormInput<String, ValidationError> {
|
||||
class Name extends RegexValidator<ValidationStandardError> {
|
||||
/// {@macro name}
|
||||
const Name.pure() : super.pure('');
|
||||
const Name.pure() : super.pure();
|
||||
|
||||
/// {@macro name}
|
||||
const Name.dirty([String value = '']) : super.dirty(value);
|
||||
|
||||
static final RegExp _nameRegExp = RegExp(r"^([ \u00c0-\u01ffa-zA-Z'\-])+$");
|
||||
const Name.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return _nameRegExp.hasMatch(value ?? '') ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
@override
|
||||
ValidationStandardError get onError => ValidationStandardError.invalid;
|
||||
|
||||
@override
|
||||
RegExp get regex => RegExp(r"^([ \u00c0-\u01ffa-zA-Z'\-])+$");
|
||||
}
|
||||
+10
-12
@@ -15,25 +15,23 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/regex_validator.dart';
|
||||
|
||||
/// {@template password}
|
||||
/// Form input for a password input.
|
||||
/// {@endtemplate}
|
||||
class Password extends FormInput<String, ValidationError> {
|
||||
class Password extends RegexValidator<ValidationStandardError> {
|
||||
/// {@macro password}
|
||||
const Password.pure() : super.pure('');
|
||||
const Password.pure() : super.pure();
|
||||
|
||||
/// {@macro password}
|
||||
const Password.dirty([String value = '']) : super.dirty(value);
|
||||
|
||||
static final RegExp _passwordRegExp =
|
||||
RegExp(r'^(?=.*[A-Za-z])(?=.*\d)[A-Za-z\d]{8,}$');
|
||||
const Password.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return _passwordRegExp.hasMatch(value ?? '')
|
||||
? null
|
||||
: ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
@override
|
||||
ValidationStandardError get onError => ValidationStandardError.invalid;
|
||||
|
||||
@override
|
||||
RegExp get regex => RegExp(r'^(?=.*[A-Za-z])(?=.*\d)[A-Za-z\d]{8,}$');
|
||||
}
|
||||
+11
-10
@@ -15,23 +15,24 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/regex_validator.dart';
|
||||
|
||||
/// {@template phone}
|
||||
/// Form input for a phone input.
|
||||
/// {@endtemplate}
|
||||
class Phone extends FormInput<String, ValidationError> {
|
||||
class Phone extends RegexValidator<ValidationStandardError> {
|
||||
/// {@macro phone}
|
||||
const Phone.pure() : super.pure('');
|
||||
const Phone.pure() : super.pure();
|
||||
|
||||
/// {@macro phone}
|
||||
const Phone.dirty([String value = '']) : super.dirty(value);
|
||||
|
||||
static final RegExp _phoneRegExp =
|
||||
RegExp(r'^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$');
|
||||
const Phone.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return _phoneRegExp.hasMatch(value ?? '') ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
@override
|
||||
ValidationStandardError get onError => ValidationStandardError.invalid;
|
||||
|
||||
@override
|
||||
RegExp get regex =>
|
||||
RegExp(r'^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$');
|
||||
}
|
||||
+10
-9
@@ -15,22 +15,23 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/regex_validator.dart';
|
||||
|
||||
/// {@template siren}
|
||||
/// Form input for a SIREN input.
|
||||
/// {@endtemplate}
|
||||
class Siren extends FormInput<String, ValidationError> {
|
||||
class Siren extends RegexValidator<ValidationStandardError> {
|
||||
/// {@macro siren}
|
||||
const Siren.pure() : super.pure('');
|
||||
const Siren.pure() : super.pure();
|
||||
|
||||
/// {@macro siren}
|
||||
const Siren.dirty([String value = '']) : super.dirty(value);
|
||||
|
||||
static final RegExp _regExp = RegExp(r'(\d{9}|\d{3}[ ]\d{3}[ ]\d{3})$');
|
||||
const Siren.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return _regExp.hasMatch(value ?? '') ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
@override
|
||||
ValidationStandardError get onError => ValidationStandardError.invalid;
|
||||
|
||||
@override
|
||||
RegExp get regex => RegExp(r'(\d{9}|\d{3}[ ]\d{3}[ ]\d{3})$');
|
||||
}
|
||||
+8
-7
@@ -15,20 +15,21 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
import 'package:wyatt_form_bloc/src/enums/enums.dart';
|
||||
import 'package:wyatt_form_bloc/src/form/form.dart';
|
||||
import 'package:wyatt_form_bloc/src/validators/inputs/base/text_validator.dart';
|
||||
|
||||
/// {@template text_string}
|
||||
/// Form input for a text input
|
||||
/// {@endtemplate}
|
||||
class TextString extends FormInput<String, ValidationError> {
|
||||
class TextString extends TextValidator<ValidationStandardError> {
|
||||
/// {@macro text_string}
|
||||
const TextString.pure() : super.pure('');
|
||||
const TextString.pure() : super.pure();
|
||||
|
||||
/// {@macro text_string}
|
||||
const TextString.dirty([String value = '']) : super.dirty(value);
|
||||
const TextString.dirty([super.value = '']) : super.dirty();
|
||||
|
||||
@override
|
||||
ValidationError? validator(String? value) {
|
||||
return (value?.isNotEmpty ?? false) ? null : ValidationError.invalid;
|
||||
}
|
||||
ValidationStandardError get onEmpty => ValidationStandardError.empty;
|
||||
|
||||
@override
|
||||
ValidationStandardError get onNull => ValidationStandardError.invalid;
|
||||
}
|
||||
@@ -14,13 +14,16 @@
|
||||
// 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 'boolean.dart';
|
||||
export 'confirmed_password.dart';
|
||||
export 'email.dart';
|
||||
export 'iban.dart';
|
||||
export 'list_option.dart';
|
||||
export 'name.dart';
|
||||
export 'password.dart';
|
||||
export 'phone.dart';
|
||||
export 'siren.dart';
|
||||
export 'text_string.dart';
|
||||
export 'inputs/base/regex_validator.dart';
|
||||
export 'inputs/base/text_validator.dart';
|
||||
export 'inputs/boolean.dart';
|
||||
export 'inputs/confirmed_password.dart';
|
||||
export 'inputs/email.dart';
|
||||
export 'inputs/enum_validator.dart';
|
||||
export 'inputs/iban.dart';
|
||||
export 'inputs/list_option.dart';
|
||||
export 'inputs/name.dart';
|
||||
export 'inputs/password.dart';
|
||||
export 'inputs/phone.dart';
|
||||
export 'inputs/siren.dart';
|
||||
export 'inputs/text_string.dart';
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
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.2
|
||||
version: 0.0.4
|
||||
|
||||
environment:
|
||||
sdk: '>=2.16.2 <3.0.0'
|
||||
sdk: '>=2.17.2 <3.0.0'
|
||||
|
||||
dependencies:
|
||||
bloc: ^8.0.3
|
||||
meta: ^1.7.0
|
||||
equatable: ^2.0.3
|
||||
|
||||
dev_dependencies:
|
||||
test: ^1.21.0
|
||||
test: ^1.21.4
|
||||
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.1.0
|
||||
ref: wyatt_analysis-v2.2.1
|
||||
path: packages/wyatt_analysis
|
||||
|
||||
@@ -14,5 +14,5 @@ dev_dependencies:
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.0.1
|
||||
ref: wyatt_analysis-v2.2.1
|
||||
path: packages/wyatt_analysis
|
||||
|
||||
@@ -48,7 +48,7 @@ dev_dependencies:
|
||||
# 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: ^1.0.0
|
||||
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
|
||||
|
||||
@@ -15,5 +15,5 @@ dev_dependencies:
|
||||
wyatt_analysis:
|
||||
git:
|
||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
ref: wyatt_analysis-v2.1.0
|
||||
ref: wyatt_analysis-v2.2.1
|
||||
path: packages/wyatt_analysis
|
||||
|
||||
@@ -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
|
||||
@@ -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"
|
||||
]
|
||||
}
|
||||
+16
@@ -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"
|
||||
},
|
||||
]
|
||||
}
|
||||
+71
@@ -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,
|
||||
}
|
||||
@@ -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>
|
||||
@@ -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.
|
||||
@@ -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>.
|
||||
@@ -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);
|
||||
```
|
||||
+3
-5
@@ -14,9 +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/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.flutter.2.0.0.yaml
|
||||
include: package:wyatt_analysis/analysis_options.yaml
|
||||
|
||||
linter:
|
||||
rules:
|
||||
- use_super_parameters
|
||||
- use_enums
|
||||
analyzer:
|
||||
exclude: "!example/**"
|
||||
@@ -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);
|
||||
}
|
||||
@@ -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)}');
|
||||
}
|
||||
@@ -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;
|
||||
}
|
||||
@@ -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
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
// 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/>.
|
||||
@@ -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,
|
||||
);
|
||||
}
|
||||
@@ -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));
|
||||
}
|
||||
@@ -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;
|
||||
}
|
||||
@@ -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
Reference in New Issue
Block a user