Updated serialize

2021-08-02 20:38:47 +08:00 · 2021-08-02 20:38:47 +08:00 · de18c82e66
commit de18c82e66
parent c24b0095da
5 changed files with 109 additions and 72 deletions
--- a/packages/orm/README.md
+++ b/packages/orm/README.md
@ -1,4 +1,5 @@
 # ORM
+
 [![version](https://img.shields.io/badge/pub-v4.0.0-brightgreen)](https://pub.dartlang.org/packages/angel3_orm)
 [![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
 [![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)
@ -10,33 +11,38 @@ Source-generated ORM for use with the [Angel3 framework](https://github.com/duke
 Documentation for migrations can be found here:
 [ORM Migration](https://angel3-docs.dukefirehawk.com/guides/orm/migrations)

-* [Usage](#usage)
-* [Model Definitions](#models)
-* [MVC Example](#example)
-* [Relationships](#relations)
-  * [Many-to-Many Relationships](#many-to-many-relations)
-* [Columns (`@Column(...)`)](#columns)
-    * [Column Types](#column-types)
-    * [Indices](#indices)
-    * [Default Values](#default-values)
+- [ORM](#orm)
+  - [Usage](#usage)
+  - [Models](#models)
+  - [Example](#example)
+  - [Relations](#relations)
+    - [Many to Many Relations](#many-to-many-relations)
+  - [Columns](#columns)
+    - [Column Types](#column-types)
+    - [Indices](#indices)
+    - [Default Values](#default-values)
+
+## Usage

-# Usage
 You'll need these dependencies in your `pubspec.yaml`:
+
 ```yaml
 dependencies:
-  angel3_orm: ^4.0.0-beta.1
+  angel3_orm: ^4.0.0
 dev_dependencies:
-  angel3_orm_generator: ^4.0.0-beta.1
+  angel3_orm_generator: ^4.0.0
  build_runner: ^2.0.0
 ```

 `package:angel3_orm_generator` exports a class that you can include in a `package:build` flow:
-* `PostgresOrmGenerator` - Fueled by `package:source_gen`; include this within a `SharedPartBuilder`.
+
+- `PostgresOrmGenerator` - Fueled by `package:source_gen`; include this within a `SharedPartBuilder`.

 However, it also includes a `build.yaml` that builds ORM files automatically, so you shouldn't
 have to do any configuration at all.

-# Models
+## Models
+
 The ORM works best when used with `package:angel3_serialize`:

 ```dart
@ -74,14 +80,14 @@ Remember that if you don't need automatic id-and-date fields, you can
 simply just not extend `Model`:

 ```dart
-@Serializable(autoIdAndDateFields: false)
+@Serializable
 abstract class _ThisIsNotAnAngelModel {
  @primaryKey
  String get username;
 }
 ```

-# Example
+## Example

 MVC just got a whole lot easier:

@ -126,7 +132,7 @@ class CarController extends Controller {
  
  @Expose('/create', method: 'POST')
  createCar(QueryExecutor executor) async {
-    // `package:angel_orm` generates a strongly-typed `insert` function on the query class.
+    // `package:angel3_orm` generates a strongly-typed `insert` function on the query class.
    // Say goodbye to typos!!!
    var query = CarQuery();
    query.values
@ -140,13 +146,14 @@ class CarController extends Controller {
 }
 ```

-# Relations
+## Relations
+
 `angel3_orm` supports the following relationships:

-* `@HasOne()` (one-to-one)
-* `@HasMany()` (one-to-many)
-* `@BelongsTo()` (one-to-one)
-* `@ManyToMany()` (many-to-many, using a "pivot" table)
+- `@HasOne()` (one-to-one)
+- `@HasMany()` (one-to-many)
+- `@BelongsTo()` (one-to-one)
+- `@ManyToMany()` (many-to-many, using a "pivot" table)

 The annotations can be abbreviated with the default options (ex. `@hasOne`), or supplied
 with custom parameters (ex. `@HasOne(foreignKey: 'foreign_id')`).
@ -168,17 +175,16 @@ abstract class _Author extends Model {
 }
 ```

-The relationships will "just work" out-of-the-box, following any operation. For example,
-after fetching an `Author` from the database in the above example, the `books` field would
-be populated with a set of deserialized `Book` objects, also fetched from the database.
+The relationships will "just work" out-of-the-box, following any operation. For example, after fetching an `Author` from the database in the above example, the `books` field would be populated with a set of deserialized `Book` objects, also fetched from the database.

 Relationships use joins when possible, but in the case of `@HasMany()`, two queries are used:
-* One to fetch the object itself
-* One to fetch a list of related objects

-## Many to Many Relations
-A many-to-many relationship can now be modeled like so.
-`RoleUser` in this case is a pivot table joining `User` and `Role`.
+- One to fetch the object itself
+- One to fetch a list of related objects
+
+### Many to Many Relations
+
+A many-to-many relationship can now be modeled like so. `RoleUser` in this case is a pivot table joining `User` and `Role`.

 Note that in this case, the models must reference the private classes (`_User`, etc.), because the canonical versions (`User`, etc.) are not-yet-generated:

@ -215,17 +221,20 @@ abstract class _Role extends Model {
 ```

 TLDR:
+
 1. Make a pivot table, C, between two tables, table A and B
 2. C should `@belongsTo` both A and B. C *should not* extend `Model`.
 3. A should have a field: `@ManyToMany(_C) List<_B> get b;`
 4. B should have a field: `@ManyToMany(_C) List<_A> get a;`

-Test: https://raw.githubusercontent.com/angel-dart/orm/master/angel_orm_generator/test/many_to_many_test.dart
+Test: <https://raw.githubusercontent.com/angel-dart/orm/master/angel_orm_generator/test/many_to_many_test.dart>
+
+## Columns

-# Columns
 Use a `@Column()` annotation to change how a given field is handled within the ORM.

-## Column Types
+### Column Types
+
 Using the `@Column()` annotation, it is possible to explicitly declare the data type of any given field:

 ```dart
@ -237,7 +246,8 @@ abstract class _Foo extends Model {
 }
 ```

-## Indices
+### Indices
+
 Columns can also have an `index`:

 ```dart
@ -249,13 +259,12 @@ abstract class _Foo extends Model {
 }
 ```

-## Default Values
+### Default Values
+
 It is also possible to specify the default value of a field.
 **Note that this only works with primitive objects.**

-If a default value is supplied, the `SqlMigrationBuilder` will include
-it in the generated schema. The `PostgresOrmGenerator` ignores default values;
-it does not need them to function properly.
+If a default value is supplied, the `SqlMigrationBuilder` will include it in the generated schema. The `PostgresOrmGenerator` ignores default values; it does not need them to function properly.

 ```dart
@serializable
--- a/packages/serialize/angel_serialize/CHANGELOG.md
+++ b/packages/serialize/angel_serialize/CHANGELOG.md
@ -1,54 +1,80 @@
-# 4.0.0
+# Change Log
+
+## 4.0.1
+
+* Updated README
+* Removed deprecated field `autoIdAndDateFields`
+* Removed deprecated class `DefaultValue`
+* Removed deprecated class `Alias`
+
+## 4.0.0
+
 * Migrated to support Dart SDK 2.12.x NNBD
 * Migrateed quiver_hashcode to quiver

-# 3.0.0
+## 3.0.0
+
 * Migrated to work with Dart SDK 2.12.x Non NNBD

-# 2.2.3+3
+## 2.2.3+3
+
 * Add `exclude: true` to `super` call in `Exclude` constructor.

-# 2.2.3+2
+## 2.2.3+2
+
 * Apply `package:pedantic`.

-# 2.2.3+1
+## 2.2.3+1
+
 * Export `json`, `Codec`, and `Converter` from `dart:convert`.

-# 2.2.3
+## 2.2.3
+
 * `isNullable` defaults to `true`, and will not change.
 * Deprecate `@nullable`.
 * Add `@notNull`.

-# 2.2.2+1
+## 2.2.2+1
+
 * Export commonly-used packages, for the sake of convenience.

-# 2.2.2
+## 2.2.2
+
 * Add `HasAlias`, `DefaultsTo`, `nullable` idioms.
 * `isNullable` defaults to `false` now.

-# 2.2.1
+## 2.2.1
+
 * Add `serializesTo`.

-# 2.2.0
+## 2.2.0
+
 * Add `@SerializableField`.

-# 2.1.0
+## 2.1.0
+
 * Export `hashObjects`.

-# 2.0.4+1
+## 2.0.4+1
+
 * Allow Dart 1 for this annotation-only package.

-# 2.0.4
+## 2.0.4
+
 * Added `generatedSerializable`.

-# 2.0.3
+## 2.0.3
+
 * Increased the upper SDK boundary.

-# 2.0.2
+## 2.0.2
+
 * Added `DefaultValue`.

-# 2.0.1
+## 2.0.1
+
 * Added `Serializers.typescript`.

-# 2.0.0
+## 2.0.0
+
 * Dart 2+ constraint
--- a/packages/serialize/angel_serialize/README.md
+++ b/packages/serialize/angel_serialize/README.md
@ -1,11 +1,9 @@
-# angel3_serialize
-[![version](https://img.shields.io/badge/pub-v4.0.0-brightgreen)](https://pub.dartlang.org/packages/angel3_serialize)
+# Angel3 Serialization
+
+[![version](https://img.shields.io/badge/pub-v4.0.1-brightgreen)](https://pub.dartlang.org/packages/angel3_serialize)
 [![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety)
 [![Gitter](https://img.shields.io/gitter/room/angel_dart/discussion)](https://gitter.im/angel_dart/discussion)

 [![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/tree/angel3/packages/serialize/angel_serialize/LICENSE)

-The frontend for Angel model serialization.
-See documentation in the main project repo:
-
-https://github.com/angel-dart/serialize
+The frontend for Angel3 model serialization. See [`Documentation`](https://pub.dev/documentation/angel3_serialize/latest/)
--- a/packages/serialize/angel_serialize/lib/angel3_serialize.dart
+++ b/packages/serialize/angel_serialize/lib/angel3_serialize.dart
@ -14,8 +14,8 @@ class Exclude extends SerializableField {
 }

 /// No longer necessary, as this is the default.
-@deprecated
-const SerializableField nullable = SerializableField(isNullable: true);
+//@deprecated
+//const SerializableField nullable = SerializableField(isNullable: true);

 /// Marks a field as not accepting `null` values.
 const SerializableField notNull = SerializableField(isNullable: false);
@ -88,7 +88,7 @@ class Serializable {
      {this.serializers = const [Serializers.map, Serializers.json],
      this.autoSnakeCaseNames = true,
      // ignore: deprecated_member_use_from_same_package
-      @deprecated this.autoIdAndDateFields = true,
+      //@deprecated this.autoIdAndDateFields = true,
      this.includeAnnotations = const []});

  /// A list of enabled serialization modes.
@ -100,8 +100,8 @@ class Serializable {
  final bool autoSnakeCaseNames;

  /// Overrides the setting in `JsonModelGenerator`.
-  @deprecated
-  final bool autoIdAndDateFields;
+  //@deprecated
+  //final bool autoIdAndDateFields;

  /// A list of constant members to affix to the generated class.
  final List includeAnnotations;
@ -131,6 +131,7 @@ abstract class Serializers {
  static const int typescript = 2;
 }

+/*
@deprecated
 class DefaultValue {
  final value;
@ -139,10 +140,10 @@ class DefaultValue {
 }

@deprecated
-
 /// Prefer [SerializableField] instead.
 class Alias {
  final String name;

  const Alias(this.name);
 }
+*/
--- a/packages/serialize/angel_serialize/pubspec.yaml
+++ b/packages/serialize/angel_serialize/pubspec.yaml
@ -1,12 +1,15 @@
 name: angel3_serialize
-version: 4.0.0
-description: Static annotations powering Angel model serialization. Combine with angel_serialize_generator for flexible modeling.
-homepage: https://github.com/dukefirehawk/angel/tree/angel3/packages/serialize/angel_serialize
+version: 4.0.1
+description: Static annotations powering Angel3 model serialization. Combine with angel3_serialize_generator for flexible modeling.
+homepage: https://angel3-framework.web.app/
+repository: https://github.com/dukefirehawk/angel/tree/angel3/packages/serialize/angel_serialize
 environment:
  sdk: '>=2.12.0 <3.0.0'
 dependencies:
  angel3_model: ^3.0.0
  collection: ^1.15.0
  meta: ^1.3.0
-  pedantic: ^1.11.0
  quiver: ^3.0.1
+dev_dependencies:
+  pedantic: ^1.11.0
+