Updated validate
This commit is contained in:
thomashii
parent
6272987ccd
commit
01040973b7
6 changed files with 56 additions and 62 deletions
|
|
@ -17,7 +17,7 @@
|
|||
* Migrated angel_framework to 4.0.0 (149/150 tests passed)
|
||||
* Migrated angel_auth to 4.0.0 (31/31 tests passed)
|
||||
* Migrated angel_configuration to 4.0.0 (8/8 testspassed)
|
||||
* Migrated angel_validate to 4.0.0 (6/7 tests passed)
|
||||
* Migrated angel_validate to 4.0.0 (7/7 tests passed)
|
||||
* Migrated json_god to 4.0.0 (13/13 tests passed)
|
||||
* Migrated angel_client to 4.0.0 (6/13 tests passed)
|
||||
* Migrated angel_websocket to 4.0.0 (2/3 tests passed)
|
||||
|
|
|
|||
|
|
@ -1,33 +1,50 @@
|
|||
# 4.0.1
|
||||
# Change Log
|
||||
|
||||
## 4.0.2
|
||||
|
||||
* Updated broken links in README
|
||||
* All 7 unit test passed
|
||||
|
||||
## 4.0.1
|
||||
|
||||
* Updated README
|
||||
|
||||
# 4.0.0
|
||||
## 4.0.0
|
||||
|
||||
* Migrated to support Dart SDK 2.12.x NNBD
|
||||
|
||||
# 3.0.0
|
||||
## 3.0.0
|
||||
|
||||
* Migrated to work with Dart SDK 2.12.x Non NNBD
|
||||
|
||||
# 2.0.2
|
||||
## 2.0.2
|
||||
|
||||
* Deduplicate error messages.
|
||||
|
||||
# 2.0.1+1
|
||||
## 2.0.1+1
|
||||
|
||||
* Fix bug in the implementation of `maxLength`.
|
||||
|
||||
# 2.0.1
|
||||
## 2.0.1
|
||||
|
||||
* Patch for updated body parsing.
|
||||
|
||||
# 2.0.0
|
||||
## 2.0.0
|
||||
|
||||
* Finish update for Angel 2.
|
||||
|
||||
# 2.0.0-alpha.1
|
||||
## 2.0.0-alpha.1
|
||||
|
||||
* Update for Angel 2.
|
||||
|
||||
# 1.0.5-beta
|
||||
## 1.0.5-beta
|
||||
|
||||
* Use `wrapMatcher` on explicit values instead of throwing.
|
||||
* Add async matchers.
|
||||
* Add context-aware matchers.
|
||||
|
||||
# 1.0.4
|
||||
## 1.0.4
|
||||
|
||||
* `isNonEmptyString` trims strings.
|
||||
* `ValidationException` extends `AngelHttpException`.
|
||||
* Added `requireField` and `requireFields`.
|
||||
|
|
@ -1,23 +1,18 @@
|
|||
# angel3_validate
|
||||
# Angel3 Request Validator
|
||||
|
||||
[](https://pub.dartlang.org/packages/angel3_validate)
|
||||
[](https://pub.dartlang.org/packages/angel3_validate)
|
||||
[](https://dart.dev/null-safety)
|
||||
[](https://gitter.im/angel_dart/discussion)
|
||||
|
||||
[](https://github.com/dukefirehawk/angel/tree/angel3/packages/validate/LICENSE)
|
||||
|
||||
[Live Example](https://angel-dart.github.io/validate)
|
||||
Validation library based on the `matcher` library, with Angel3 support. Why re-invent the wheel, when you can use the same validators you already use for tests?
|
||||
|
||||
Validation library based on the `matcher` library, with Angel support.
|
||||
Why re-invent the wheel, when you can use the same validators you already
|
||||
use for tests?
|
||||
|
||||
This library runs both on the server, and on the client. Thus, you can use
|
||||
the same validation rules for forms on the server, and on the frontend.
|
||||
This library runs both on the server, and on the client. Thus, you can use the same validation rules for forms on the server, and on the frontend.
|
||||
|
||||
For convenience's sake, this library also exports `matcher`.
|
||||
|
||||
- [angel3_validate](#angel3_validate)
|
||||
- [Angel3 Request Validator](#angel3-request-validator)
|
||||
- [Examples](#examples)
|
||||
- [Creating a Validator](#creating-a-validator)
|
||||
- [Validating data](#validating-data)
|
||||
|
|
@ -58,9 +53,7 @@ main() {
|
|||
|
||||
### Validating data
|
||||
|
||||
The `Validator` will filter out fields that have no validation rules.
|
||||
You can rest easy knowing that attackers cannot slip extra data into
|
||||
your applications.
|
||||
The `Validator` will filter out fields that have no validation rules. You can rest easy knowing that attackers cannot slip extra data into your applications.
|
||||
|
||||
```dart
|
||||
main() {
|
||||
|
|
@ -92,8 +85,7 @@ main() {
|
|||
|
||||
Fields are optional by default.
|
||||
|
||||
Suffix a field name with a `'*'` to mark it as required, and
|
||||
to throw an error if it is not present.
|
||||
Suffix a field name with a `'*'` to mark it as required, and to throw an error if it is not present.
|
||||
|
||||
```dart
|
||||
main() {
|
||||
|
|
@ -108,13 +100,11 @@ main() {
|
|||
|
||||
### Forbidden Fields
|
||||
|
||||
To prevent a field from showing up in valid data, suffix it
|
||||
with a `'!'`.
|
||||
To prevent a field from showing up in valid data, suffix it with a `'!'`.
|
||||
|
||||
### Default values
|
||||
|
||||
If not present, default values will be filled in *before* validation.
|
||||
This means that they can still be used with required fields.
|
||||
If not present, default values will be filled in *before* validation. This means that they can still be used with required fields.
|
||||
|
||||
```dart
|
||||
final Validator todo = Validator({
|
||||
|
|
@ -125,17 +115,13 @@ final Validator todo = Validator({
|
|||
});
|
||||
```
|
||||
|
||||
Default values can also be parameterless, *synchronous* functions
|
||||
that return a single value.
|
||||
Default values can also be parameterless, *synchronous* functions that return a single value.
|
||||
|
||||
### Custom Validator Functions
|
||||
|
||||
Creating a whole `Matcher` class is sometimes cumbersome, but if
|
||||
you pass a function to the constructor, it will be wrapped in a
|
||||
`Matcher` instance.
|
||||
Creating a whole `Matcher` class is sometimes cumbersome, but if you pass a function to the constructor, it will be wrapped in a `Matcher` instance.
|
||||
|
||||
(It simply returns the value of calling
|
||||
[`predicate`](https://www.dartdocs.org/documentation/matcher/0.12.0%2B2/matcher/predicate.html).)
|
||||
(It simply returns the value of calling [`predicate`](https://pub.dev/documentation/matcher/latest/matcher/predicate.html).)
|
||||
|
||||
The function must *synchronously* return a `bool`.
|
||||
|
||||
|
|
@ -152,8 +138,7 @@ main() {
|
|||
|
||||
### Custom Error Messages
|
||||
|
||||
If these are not present, `angel3_validate` will *attempt* to generate
|
||||
a coherent error message on its own.
|
||||
If these are not present, `angel3_validate` will *attempt* to generate a coherent error message on its own.
|
||||
|
||||
```dart
|
||||
Validator({
|
||||
|
|
@ -196,9 +181,7 @@ print(only); // { foo: bar }
|
|||
|
||||
### Extending Validators
|
||||
|
||||
You can add situation-specific rules within a child validator.
|
||||
You can also use `extend` to mark fields as required or forbidden that originally
|
||||
were not. Default value and custom error message extension is also supported.
|
||||
You can add situation-specific rules within a child validator. You can also use `extend` to mark fields as required or forbidden that originally were not. Default value and custom error message extension is also supported.
|
||||
|
||||
```dart
|
||||
final Validator userValidator = Validator({
|
||||
|
|
@ -210,8 +193,7 @@ final Validator userValidator = Validator({
|
|||
});
|
||||
```
|
||||
|
||||
To mark a field as now optional, and no longer required,
|
||||
suffix its name with a `'?'`.
|
||||
To mark a field as now optional, and no longer required, suffix its name with a `'?'`.
|
||||
|
||||
```dart
|
||||
var ageIsOptional = userValidator.extend({
|
||||
|
|
@ -222,9 +204,7 @@ var ageIsOptional = userValidator.extend({
|
|||
});
|
||||
```
|
||||
|
||||
Note that by default, validation rules are simply appended to
|
||||
the existing list. To completely overwrite existing rules, set the
|
||||
`overwrite` flag to `true`.
|
||||
Note that by default, validation rules are simply appended to the existing list. To completely overwrite existing rules, set the `overwrite` flag to `true`.
|
||||
|
||||
```dart
|
||||
register(Map userData) {
|
||||
|
|
@ -236,8 +216,7 @@ register(Map userData) {
|
|||
|
||||
### Bundled Matchers
|
||||
|
||||
This library includes some `Matcher`s for common validations,
|
||||
including:
|
||||
This library includes some `Matcher`s for common validations, including:
|
||||
|
||||
- `isAlphaDash`: Asserts that a `String` is alphanumeric, but also lets it contain dashes or underscores.
|
||||
- `isAlphaNum`: Asserts that a `String` is alphanumeric.
|
||||
|
|
@ -249,14 +228,11 @@ including:
|
|||
- `isNonEmptyString`: Asserts that a value is a non-empty `String`.
|
||||
- `isUrl`: Asserts that a `String` is an HTTPS or HTTP URL.
|
||||
|
||||
The remaining functionality is
|
||||
[effectively implemented by the `matcher` package](https://www.dartdocs.org/documentation/matcher/0.12.0%2B2/matcher/matcher-library.html).
|
||||
The remaining functionality is [effectively implemented by the `matcher` package](https://pub.dev/documentation/matcher/latest/matcher/matcher-library.html).
|
||||
|
||||
### Nested Validators
|
||||
|
||||
Very often, the data we validate contains other data within. You can pass
|
||||
a `Validator` instance to the constructor, because it extends the
|
||||
`Matcher` class.
|
||||
Very often, the data we validate contains other data within. You can pass a `Validator` instance to the constructor, because it extends the `Matcher` class.
|
||||
|
||||
```dart
|
||||
main() {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,8 @@
|
|||
name: angel3_validate
|
||||
description: Cross-platform request body validation library based on `matcher`.
|
||||
version: 4.0.1
|
||||
homepage: https://github.com/dukefirehawk/angel/tree/angel3/packages/validate
|
||||
version: 4.0.2
|
||||
homepage: https://angel3-framework.web.app/
|
||||
repository: https://github.com/dukefirehawk/angel/tree/angel3/packages/validate
|
||||
environment:
|
||||
sdk: '>=2.12.0 <3.0.0'
|
||||
dependencies:
|
||||
|
|
@ -10,9 +11,9 @@ dependencies:
|
|||
matcher: ^0.12.0
|
||||
dev_dependencies:
|
||||
#angel3_test:
|
||||
angel3_mock_request: ^2.0.0
|
||||
build_runner: ^1.11.1
|
||||
build_web_compilers: ^2.12.2
|
||||
logging: ^1.0.1
|
||||
angel3_mock_request: ^2.0.0
|
||||
pedantic: ^1.0.0
|
||||
pedantic: ^1.11.0
|
||||
test: ^1.17.4
|
||||
|
|
@ -12,7 +12,7 @@ import 'package:test/test.dart';
|
|||
final Validator echoSchema = Validator({'message*': isString});
|
||||
|
||||
void printRecord(LogRecord rec) {
|
||||
print(rec);
|
||||
print('${rec.time}: ${rec.level.name}: ${rec.loggerName}: ${rec.message}');
|
||||
if (rec.error != null) print(rec.error);
|
||||
if (rec.stackTrace != null) print(rec.stackTrace);
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue